From fb17f11408d1b1332657f3656749b48f12740633 Mon Sep 17 00:00:00 2001 From: twilio-dx Date: Tue, 18 Jun 2024 17:27:11 +0000 Subject: [PATCH] oaiFeat: Updated api definitions --- CHANGES.md | 25 + package-lock.json | 64 +- .../twilio-api/twilio_accounts_v1.json | 850 +- src/services/twilio-api/twilio_api_v2010.json | 18271 +++++++++++++--- .../twilio-api/twilio_bulkexports_v1.json | 623 +- src/services/twilio-api/twilio_chat_v1.json | 3021 ++- src/services/twilio-api/twilio_chat_v2.json | 3866 +++- src/services/twilio-api/twilio_chat_v3.json | 89 +- .../twilio-api/twilio_content_sdk.json | 1829 ++ .../twilio-api/twilio_content_v1.json | 905 +- .../twilio-api/twilio_content_v2.json | 904 + .../twilio-api/twilio_conversations_v1.json | 8452 ++++++- src/services/twilio-api/twilio_events_v1.json | 1849 +- src/services/twilio-api/twilio_flex_v1.json | 6472 +++++- src/services/twilio-api/twilio_flex_v2.json | 181 +- .../twilio-api/twilio_frontline_v1.json | 138 +- .../twilio-api/twilio_insights_v1.json | 3386 ++- .../twilio-api/twilio_intelligence_v2.json | 2191 +- .../twilio-api/twilio_ip_messaging_v1.json | 2953 ++- .../twilio-api/twilio_ip_messaging_v2.json | 3896 +++- .../twilio-api/twilio_lookups_v1.json | 363 +- .../twilio-api/twilio_lookups_v2.json | 670 +- .../twilio-api/twilio_marketplace_v1.json | 2407 ++ .../twilio-api/twilio_messaging_v1.json | 4580 +++- .../twilio-api/twilio_microvisor_v1.json | 1738 +- .../twilio-api/twilio_monitor_v1.json | 459 +- src/services/twilio-api/twilio_notify_v1.json | 1150 +- .../twilio-api/twilio_numbers_v1.json | 1051 +- .../twilio-api/twilio_numbers_v2.json | 4013 +++- src/services/twilio-api/twilio_oauth_v1.json | 160 +- src/services/twilio-api/twilio_preview.json | 7209 +++++- .../twilio-api/twilio_pricing_v1.json | 629 +- .../twilio-api/twilio_pricing_v2.json | 641 +- src/services/twilio-api/twilio_proxy_v1.json | 1986 +- src/services/twilio-api/twilio_routes_v2.json | 382 +- .../twilio-api/twilio_serverless_v1.json | 2437 ++- src/services/twilio-api/twilio_studio_v1.json | 1219 +- src/services/twilio-api/twilio_studio_v2.json | 1252 +- .../twilio-api/twilio_supersim_v1.json | 3732 +++- src/services/twilio-api/twilio_sync_v1.json | 3118 ++- .../twilio-api/twilio_taskrouter_v1.json | 5551 ++++- .../twilio-api/twilio_trunking_v1.json | 1596 +- .../twilio-api/twilio_trusthub_v1.json | 5249 ++++- src/services/twilio-api/twilio_verify_v2.json | 4455 +++- src/services/twilio-api/twilio_video_v1.json | 3244 ++- src/services/twilio-api/twilio_voice_v1.json | 2063 +- .../twilio-api/twilio_wireless_v1.json | 1587 +- 47 files changed, 109535 insertions(+), 13371 deletions(-) create mode 100644 src/services/twilio-api/twilio_content_sdk.json create mode 100644 src/services/twilio-api/twilio_content_v2.json create mode 100644 src/services/twilio-api/twilio_marketplace_v1.json diff --git a/CHANGES.md b/CHANGES.md index af894f3f..5be9ac6b 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,3 +1,28 @@ +-------------------------- + +**Library - Feature** +- [PR #111](https://github.com/twilio/twilio-oai/pull/111): Merge branch '2.0.0-rc' into main. Thanks to [@tiwarishubham635](https://github.com/tiwarishubham635)! **(breaking change)** +- [PR #110](https://github.com/twilio/twilio-oai/pull/110): Merge branch '2.0.0-rc' into main. Thanks to [@tiwarishubham635](https://github.com/tiwarishubham635)! **(breaking change)** + +**Events** +- Add `status` and `documentation_url` to Event Types + +**Lookups** +- Removed unused `fraud` lookups in V1 only to facilitate rest proxy migration + +**Numbers** +- Add date_created field to the Get Port In Request API +- Rename the `status_last_time_updated_timestamp` field to `last_updated` in the Get Port In Phone Number API **(breaking change)** +- Add Rejection reason and rejection reason code to the Get Port In Phone Number API +- Remove the carrier information from the Portability API + +**Proxy** +- Change property `type` from enum to ienum + +**Trusthub** +- Add skipMessagingUseCase field in compliance_tollfree_inquiry. + + ### [7.24.1](https://github.com/twilio/twilio-cli-core/compare/7.24.0...7.24.1) (2024-06-06) --------------------------- diff --git a/package-lock.json b/package-lock.json index d769f06b..27f85897 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@twilio/cli-core", - "version": "7.24.0", + "version": "7.24.1", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@twilio/cli-core", - "version": "7.24.0", + "version": "7.24.1", "license": "MIT", "dependencies": { "@actions/core": "^1.0.0", @@ -634,6 +634,7 @@ "version": "0.11.14", "resolved": "https://registry.npmjs.org/@humanwhocodes/config-array/-/config-array-0.11.14.tgz", "integrity": "sha512-3T8LkOmg45BV5FICb15QQMsyUSWrQ8AygVfC7ZG32zOalnqrilm018ZVCw0eapXux8FtA33q8PSRSstjee3jSg==", + "deprecated": "Use @eslint/config-array instead", "dev": true, "dependencies": { "@humanwhocodes/object-schema": "^2.0.2", @@ -661,6 +662,7 @@ "version": "2.0.3", "resolved": "https://registry.npmjs.org/@humanwhocodes/object-schema/-/object-schema-2.0.3.tgz", "integrity": "sha512-93zYdMES/c1D69yZiKDBj0V24vqNzB/koF26KPaagAfd3P/4gUlh3Dys5ogAK+Exi9QyzlD8x/08Zt7wIKcDcA==", + "deprecated": "Use @eslint/object-schema instead", "dev": true }, "node_modules/@istanbuljs/load-nyc-config": { @@ -2010,9 +2012,9 @@ "dev": true }, "node_modules/@types/lodash": { - "version": "4.17.4", - "resolved": "https://registry.npmjs.org/@types/lodash/-/lodash-4.17.4.tgz", - "integrity": "sha512-wYCP26ZLxaT3R39kiN2+HcJ4kTd3U1waI/cY7ivWYqFP6pW3ZNpvi6Wd6PHZx7T/t8z0vlkXMg3QYLa7DZ/IJQ==", + "version": "4.17.5", + "resolved": "https://registry.npmjs.org/@types/lodash/-/lodash-4.17.5.tgz", + "integrity": "sha512-MBIOHVZqVqgfro1euRDWX7OO0fBVUUMrN6Pwm8LQsz8cWhEpihlvR70ENj3f40j58TNxZaWv2ndSkInykNBBJw==", "dev": true }, "node_modules/@types/minimist": { @@ -2023,9 +2025,9 @@ "peer": true }, "node_modules/@types/node": { - "version": "20.14.2", - "resolved": "https://registry.npmjs.org/@types/node/-/node-20.14.2.tgz", - "integrity": "sha512-xyu6WAMVwv6AKFLB+e/7ySZVr/0zLCzOa7rSpq6jNwpqOrUbcACDWC+53d4n2QHOnDou0fbIsg8wZu/sxrnI4Q==", + "version": "20.14.5", + "resolved": "https://registry.npmjs.org/@types/node/-/node-20.14.5.tgz", + "integrity": "sha512-aoRR+fJkZT2l0aGOJhuA8frnCSoNX6W7U2mpNq63+BxBIj5BQFt8rHy627kijCmm63ijdSdwvGgpUsU6MBsZZA==", "dependencies": { "undici-types": "~5.26.4" } @@ -2073,9 +2075,9 @@ "dev": true }, "node_modules/acorn": { - "version": "8.11.3", - "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.11.3.tgz", - "integrity": "sha512-Y9rRfJG5jcKOE0CLisYbojUjIrIEE7AGMzA/Sm4BslANhbS+cDMpgBdcPT91oJ7OuJ9hYJBx59RjbhxVnrF8Xg==", + "version": "8.12.0", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.12.0.tgz", + "integrity": "sha512-RTvkC4w+KNXrM39/lWCUaG0IbRkWdCv7W/IOW9oU6SawyxulvkQy5HQPVTKxEjczcUvapcrw3cFx/60VN/NRNw==", "bin": { "acorn": "bin/acorn" }, @@ -2093,9 +2095,12 @@ } }, "node_modules/acorn-walk": { - "version": "8.3.2", - "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.3.2.tgz", - "integrity": "sha512-cjkyv4OtNCIeqhHrfS81QWXoCBPExR/J62oyEqepVw8WaQeSqpW2uhuLPh1m9eWhDuOo/jUXVTlifvesOWp/4A==", + "version": "8.3.3", + "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.3.3.tgz", + "integrity": "sha512-MxXdReSRhGO7VlFe1bRG/oI7/mdLV9B9JJT0N8vZOhF7gFRR5l3M8W9G8JxmKV+JC5mGqJ0QvqfSOLsCPa4nUw==", + "dependencies": { + "acorn": "^8.11.0" + }, "engines": { "node": ">=0.4.0" } @@ -2533,9 +2538,9 @@ "dev": true }, "node_modules/browserslist": { - "version": "4.23.0", - "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.23.0.tgz", - "integrity": "sha512-QW8HiM1shhT2GuzkvklfjcKDiWFXHOeFCIA/huJPwHsslwcydgk7X+z2zXpEijP98UCY7HbubZt5J2Zgvf0CaQ==", + "version": "4.23.1", + "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.23.1.tgz", + "integrity": "sha512-TUfofFo/KsK/bWZ9TWQ5O26tsWW4Uhmt8IYklbnUa70udB6P2wA7w7o4PY4muaEPBQaAX+CEnmmIA41NVHtPVw==", "dev": true, "funding": [ { @@ -2552,10 +2557,10 @@ } ], "dependencies": { - "caniuse-lite": "^1.0.30001587", - "electron-to-chromium": "^1.4.668", + "caniuse-lite": "^1.0.30001629", + "electron-to-chromium": "^1.4.796", "node-releases": "^2.0.14", - "update-browserslist-db": "^1.0.13" + "update-browserslist-db": "^1.0.16" }, "bin": { "browserslist": "cli.js" @@ -2662,9 +2667,9 @@ } }, "node_modules/caniuse-lite": { - "version": "1.0.30001629", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001629.tgz", - "integrity": "sha512-c3dl911slnQhmxUIT4HhYzT7wnBK/XYpGnYLOj4nJBaRiw52Ibe7YxlDaAeRECvA786zCuExhxIUJ2K7nHMrBw==", + "version": "1.0.30001636", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001636.tgz", + "integrity": "sha512-bMg2vmr8XBsbL6Lr0UHXy/21m84FTxDLWn2FSqMd5PrlbMxwJlQnC2YWYxVgp66PZE+BBNF2jYQUBKCo1FDeZg==", "dev": true, "funding": [ { @@ -3502,9 +3507,9 @@ } }, "node_modules/electron-to-chromium": { - "version": "1.4.792", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.4.792.tgz", - "integrity": "sha512-rkg5/N3L+Y844JyfgPUyuKK0Hk0efo3JNxUDKvz3HgP6EmN4rNGhr2D8boLsfTV/hGo7ZGAL8djw+jlg99zQyA==", + "version": "1.4.805", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.4.805.tgz", + "integrity": "sha512-8W4UJwX/w9T0QSzINJckTKG6CYpAUTqsaWcWIsdud3I1FYJcMgW9QqT1/4CBff/pP/TihWh13OmiyY8neto6vw==", "dev": true }, "node_modules/emoji-regex": { @@ -10902,6 +10907,7 @@ "version": "1.5.1", "resolved": "https://registry.npmjs.org/q/-/q-1.5.1.tgz", "integrity": "sha512-kV/CThkXo6xyFEZUugw/+pIOywXcDbFYgSct5cT3gqlbkBE1SJdwy6UQoZvodiWF/ckQLZyDE/Bu1M6gVu5lVw==", + "deprecated": "You or someone you depend on is using Q, the JavaScript Promise library that gave JavaScript developers strong feelings about promises. They can almost certainly migrate to the native JavaScript promise now. Thank you literally everyone for joining me in this bet against the odds. Be excellent to each other.\n\n(For a CapTP with native promises, see @endo/eventual-send and @endo/captp)", "dev": true, "engines": { "node": ">=0.6.0", @@ -12615,9 +12621,9 @@ } }, "node_modules/uglify-js": { - "version": "3.17.4", - "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.17.4.tgz", - "integrity": "sha512-T9q82TJI9e/C1TAxYvfb16xO120tMVFZrGA3f9/P4424DNu6ypK103y0GPFVa17yotwSyZW5iYXgjYHkGrJW/g==", + "version": "3.18.0", + "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.18.0.tgz", + "integrity": "sha512-SyVVbcNBCk0dzr9XL/R/ySrmYf0s372K6/hFklzgcp2lBFyXtw4I7BOdDjlLhE1aVqaI/SHWXWmYdlZxuyF38A==", "dev": true, "optional": true, "peer": true, diff --git a/src/services/twilio-api/twilio_accounts_v1.json b/src/services/twilio-api/twilio_accounts_v1.json index 9e20e5ce..eb768696 100644 --- a/src/services/twilio-api/twilio_accounts_v1.json +++ b/src/services/twilio-api/twilio_accounts_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "accounts.v1.auth_token_promotion": { "type": "object", @@ -213,12 +219,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -234,7 +234,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -251,8 +251,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.", @@ -265,6 +265,53 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -276,10 +323,7 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateAuthTokenPromotion", - "x-maturity": [ - "GA" - ] + "operationId": "UpdateAuthTokenPromotion" } }, "/v1/Credentials": { @@ -288,7 +332,7 @@ "url": "https://accounts.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], "pathType": "list" @@ -307,8 +351,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", @@ -358,16 +402,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -376,21 +422,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" } }, "title": "ListCredentialAwsResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -402,10 +521,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCredentialAws", - "x-maturity": [ - "GA" - ] + "operationId": "ListCredentialAws" }, "post": { "description": "Create a new AWS Credential", @@ -418,6 +534,54 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -430,9 +594,6 @@ } ], "operationId": "CreateCredentialAws", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -459,6 +620,15 @@ "required": [ "Credentials" ] + }, + "examples": { + "create": { + "value": { + "AccountSid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name", + "Credentials": "aws_credentials" + } + } } } } @@ -478,8 +648,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", @@ -506,6 +676,54 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -517,10 +735,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCredentialAws", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCredentialAws" }, "post": { "description": "Modify the properties of a given Account", @@ -547,6 +762,54 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -559,9 +822,6 @@ } ], "operationId": "UpdateCredentialAws", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -574,12 +834,17 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -611,10 +876,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCredentialAws", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCredentialAws" } }, "/v1/Credentials/PublicKeys": { @@ -630,9 +892,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", @@ -682,16 +944,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -700,21 +964,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" } }, "title": "ListCredentialPublicKeyResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -726,10 +1063,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCredentialPublicKey", - "x-maturity": [ - "GA" - ] + "operationId": "ListCredentialPublicKey" }, "post": { "description": "Create a new Public Key Credential", @@ -742,6 +1076,54 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -754,9 +1136,6 @@ } ], "operationId": "CreateCredentialPublicKey", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -783,6 +1162,15 @@ "required": [ "PublicKey" ] + }, + "examples": { + "create": { + "value": { + "AccountSid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name", + "PublicKey": "public_key" + } + } } } } @@ -802,9 +1190,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", @@ -831,6 +1219,54 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -842,10 +1278,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCredentialPublicKey", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCredentialPublicKey" }, "post": { "description": "Modify the properties of a given Account", @@ -872,6 +1305,54 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -884,9 +1365,6 @@ } ], "operationId": "UpdateCredentialPublicKey", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -899,12 +1377,17 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -936,10 +1419,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCredentialPublicKey", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCredentialPublicKey" } }, "/v1/SafeList/Numbers": { @@ -948,14 +1428,14 @@ "url": "https://accounts.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.", @@ -968,6 +1448,50 @@ "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.safelist" + }, + "examples": { + "create": { + "value": { + "sid": "GNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "phone_number": "+18001234567" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -980,9 +1504,6 @@ } ], "operationId": "CreateSafelist", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -998,6 +1519,13 @@ "required": [ "PhoneNumber" ] + }, + "examples": { + "create": { + "value": { + "PhoneNumber": "+18001234567" + } + } } } } @@ -1021,6 +1549,11 @@ "handling": "standard", "deleteSla": 0 } + }, + "examples": { + "fetch": { + "value": "+18001234567" + } } } ], @@ -1030,6 +1563,50 @@ "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.safelist" + }, + "examples": { + "fetch": { + "value": { + "sid": "GNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "phone_number": "+18001234567" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1041,10 +1618,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSafelist", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchSafelist" }, "delete": { "description": "Remove a phone number from SafeList.", @@ -1064,6 +1638,11 @@ "handling": "standard", "deleteSla": 0 } + }, + "examples": { + "delete": { + "value": "+18001234567" + } } } ], @@ -1077,10 +1656,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSafelist", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteSafelist" } }, "/v1/AuthTokens/Secondary": { @@ -1096,8 +1672,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", @@ -1110,6 +1686,53 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1121,10 +1744,7 @@ "accountSid_authToken": [] } ], - "operationId": "CreateSecondaryAuthToken", - "x-maturity": [ - "GA" - ] + "operationId": "CreateSecondaryAuthToken" }, "delete": { "description": "Delete the secondary Auth Token from your account", @@ -1141,10 +1761,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSecondaryAuthToken", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSecondaryAuthToken" } } }, @@ -1170,14 +1787,9 @@ "name": "AccountsV1SecondaryAuthToken" } ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - }, + "security": [ { - "name": "Beta", - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_api_v2010.json b/src/services/twilio-api/twilio_api_v2010.json index 75263342..45991ab1 100644 --- a/src/services/twilio-api/twilio_api_v2010.json +++ b/src/services/twilio-api/twilio_api_v2010.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "api.v2010.account": { "type": "object", @@ -1220,7 +1226,7 @@ "price": { "type": "string", "nullable": true, - "description": "The charge for this call, in the currency associated with the account. Populated after the call is completed. May not be immediately available." + "description": "The charge for this call, in the currency associated with the account. Populated after the call is completed. May not be immediately available. The price associated with a call only reflects the charge for connectivity. Charges for other call-related features such as Answering Machine Detection, Text-To-Speech, and SIP REFER are not included in this value." }, "price_unit": { "type": "string", @@ -4633,7 +4639,7 @@ "channels": { "type": "integer", "nullable": true, - "description": "The number of channels in the final recording file. Can be: `1` or `2`. You can split a call with two legs into two separate recording channels if you record using [TwiML Dial](https://www.twilio.com/docs/voice/twiml/dial#record) or the [Outbound Rest API](https://www.twilio.com/docs/voice/make-calls#manage-your-outbound-call)." + "description": "The number of channels in the final recording file. Can be: `1` or `2`." }, "source": { "type": "string", @@ -5769,6 +5775,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": { @@ -9587,12 +9612,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -9608,7 +9627,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -9625,7 +9644,6 @@ "friendly_name", "status" ], - "pathType": "list", "dependentProperties": { "addresses": { "mapping": { @@ -9777,7 +9795,8 @@ }, "resource_url": "/2010-04-01/Accounts/{account_sid}/OutgoingCallerIds.json" } - } + }, + "pathType": "list" }, "post": { "description": "Create a new Twilio Subaccount from the account making the request", @@ -9790,6 +9809,79 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -9802,9 +9894,6 @@ } ], "operationId": "CreateAccount", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -9817,12 +9906,16 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -9843,6 +9936,14 @@ "handling": "standard", "deleteSla": 30 } + }, + "examples": { + "readEmpty": { + "value": "friendly_name" + }, + "readFull": { + "value": "friendly_name" + } } }, { @@ -9852,6 +9953,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/account_enum_status" + }, + "examples": { + "readEmpty": { + "value": "active" + }, + "readFull": { + "value": "active" + } } }, { @@ -9887,6 +9996,7 @@ "content": { "application/json": { "schema": { + "title": "ListAccountResponse", "type": "object", "properties": { "accounts": { @@ -9896,53 +10006,134 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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 } }, - "title": "ListAccountResponse" + "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -9954,10 +10145,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAccount", - "x-maturity": [ - "GA" - ] + "operationId": "ListAccount" } }, "/2010-04-01/Accounts/{Sid}.json": { @@ -9973,7 +10161,6 @@ "friendly_name", "status" ], - "pathType": "instance", "dependentProperties": { "addresses": { "mapping": { @@ -10125,7 +10312,8 @@ }, "resource_url": "/2010-04-01/Accounts/{account_sid}/OutgoingCallerIds.json" } - } + }, + "pathType": "instance" }, "get": { "description": "Fetch the account specified by the provided Account Sid", @@ -10152,6 +10340,79 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -10163,10 +10424,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAccount", - "x-maturity": [ - "GA" - ] + "operationId": "FetchAccount" }, "post": { "description": "Modify the properties of a given Account", @@ -10193,6 +10451,114 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -10205,9 +10571,6 @@ } ], "operationId": "UpdateAccount", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -10225,12 +10588,22 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -10248,7 +10621,6 @@ "validated", "verified" ], - "pathType": "list", "dependentProperties": { "dependent_phone_numbers": { "mapping": { @@ -10258,7 +10630,8 @@ "resource_url": "/2010-04-01/Accounts/{account_sid}/Addresses/{address_sid}/DependentPhoneNumbers.json" } }, - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "list" }, "post": { "description": "", @@ -10285,6 +10658,64 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -10297,9 +10728,6 @@ } ], "operationId": "CreateAddress", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -10357,6 +10785,19 @@ "PostalCode", "IsoCountry" ] + }, + "examples": { + "create": { + "value": { + "City": "city", + "CustomerName": "customer_name", + "FriendlyName": "friendly_name", + "IsoCountry": "US", + "PostalCode": "postal_code", + "Region": "region", + "Street": "street" + } + } } } } @@ -10392,6 +10833,14 @@ "handling": "standard", "deleteSla": 30 } + }, + "examples": { + "readFull": { + "value": "customer_name" + }, + "readEmpty": { + "value": "customer_name" + } } }, { @@ -10406,6 +10855,14 @@ "handling": "standard", "deleteSla": 30 } + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -10415,6 +10872,14 @@ "schema": { "type": "string", "format": "iso-country-code" + }, + "examples": { + "readFull": { + "value": "US" + }, + "readEmpty": { + "value": "US" + } } }, { @@ -10450,6 +10915,7 @@ "content": { "application/json": { "schema": { + "title": "ListAddressResponse", "type": "object", "properties": { "addresses": { @@ -10459,53 +10925,125 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" } }, - "title": "ListAddressResponse" + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -10517,10 +11055,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAddress", - "x-maturity": [ - "GA" - ] + "operationId": "ListAddress" } }, "/2010-04-01/Accounts/{AccountSid}/Addresses/{Sid}.json": { @@ -10537,7 +11072,6 @@ "validated", "verified" ], - "pathType": "instance", "dependentProperties": { "dependent_phone_numbers": { "mapping": { @@ -10547,7 +11081,8 @@ "resource_url": "/2010-04-01/Accounts/{account_sid}/Addresses/{address_sid}/DependentPhoneNumbers.json" } }, - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "instance" }, "delete": { "description": "", @@ -10590,10 +11125,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteAddress", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteAddress" }, "get": { "description": "", @@ -10632,6 +11164,64 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -10643,10 +11233,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAddress", - "x-maturity": [ - "GA" - ] + "operationId": "FetchAddress" }, "post": { "description": "", @@ -10685,6 +11272,64 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -10697,9 +11342,6 @@ } ], "operationId": "UpdateAddress", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -10744,12 +11386,21 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -10766,8 +11417,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", @@ -10794,6 +11445,69 @@ "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -10806,9 +11520,6 @@ } ], "operationId": "CreateApplication", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -10913,12 +11624,30 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -10945,6 +11674,14 @@ "description": "The string that identifies the Application resources to read.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -10980,6 +11717,7 @@ "content": { "application/json": { "schema": { + "title": "ListApplicationResponse", "type": "object", "properties": { "applications": { @@ -10989,53 +11727,124 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" } }, - "title": "ListApplicationResponse" + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -11047,10 +11856,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListApplication", - "x-maturity": [ - "GA" - ] + "operationId": "ListApplication" } }, "/2010-04-01/Accounts/{AccountSid}/Applications/{Sid}.json": { @@ -11066,8 +11872,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", @@ -11110,10 +11916,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteApplication", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteApplication" }, "get": { "description": "Fetch the application specified by the provided sid", @@ -11152,6 +11955,69 @@ "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -11163,10 +12029,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchApplication", - "x-maturity": [ - "GA" - ] + "operationId": "FetchApplication" }, "post": { "description": "Updates the application's properties", @@ -11205,6 +12068,69 @@ "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -11217,9 +12143,6 @@ } ], "operationId": "UpdateApplication", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -11324,12 +12247,30 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -11345,8 +12286,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", @@ -11385,6 +12326,58 @@ "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", + "permissions": [ + "get-all" + ], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps/CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -11396,10 +12389,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAuthorizedConnectApp", - "x-maturity": [ - "GA" - ] + "operationId": "FetchAuthorizedConnectApp" } }, "/2010-04-01/Accounts/{AccountSid}/AuthorizedConnectApps.json": { @@ -11414,8 +12404,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", @@ -11468,6 +12458,7 @@ "content": { "application/json": { "schema": { + "title": "ListAuthorizedConnectAppResponse", "type": "object", "properties": { "authorized_connect_apps": { @@ -11477,53 +12468,113 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "examples": { + "readFull": { + "value": { + "authorized_connect_apps": [ + { + "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", + "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", + "next_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json?Page=2&PageSize=50", + "page": 0, + "page_size": 50, + "previous_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json?Page=1&PageSize=50", + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json" } }, - "title": "ListAuthorizedConnectAppResponse" + "readEmpty": { + "value": { + "authorized_connect_apps": [], + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.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/AuthorizedConnectApps.json" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -11535,10 +12586,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAuthorizedConnectApp", - "x-maturity": [ - "GA" - ] + "operationId": "ListAuthorizedConnectApp" } }, "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers.json": { @@ -11554,7 +12602,6 @@ "country", "beta" ], - "pathType": "list", "dependentProperties": { "local": { "mapping": { @@ -11607,7 +12654,8 @@ } }, "parent": "/Accounts/{Sid}.json", - "className": "available_phone_number_country" + "className": "available_phone_number_country", + "pathType": "list" }, "get": { "description": "", @@ -11660,6 +12708,7 @@ "content": { "application/json": { "schema": { + "title": "ListAvailablePhoneNumberCountryResponse", "type": "object", "properties": { "countries": { @@ -11669,53 +12718,97 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" } }, - "title": "ListAvailablePhoneNumberCountryResponse" + "readEmpty": { + "value": { + "countries": [], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers.json" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -11727,10 +12820,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAvailablePhoneNumberCountry", - "x-maturity": [ - "GA" - ] + "operationId": "ListAvailablePhoneNumberCountry" } }, "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json": { @@ -11746,7 +12836,6 @@ "country", "beta" ], - "pathType": "instance", "dependentProperties": { "local": { "mapping": { @@ -11799,7 +12888,8 @@ } }, "parent": "/Accounts/{Sid}.json", - "className": "available_phone_number_country" + "className": "available_phone_number_country", + "pathType": "instance" }, "get": { "description": "", @@ -11836,6 +12926,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -11847,10 +12987,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAvailablePhoneNumberCountry", - "x-maturity": [ - "GA" - ] + "operationId": "FetchAvailablePhoneNumberCountry" } }, "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Local.json": { @@ -11866,8 +13003,8 @@ "region", "beta" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json" + "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json", + "pathType": "list" }, "get": { "description": "", @@ -11967,6 +13104,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" + } } }, { @@ -12075,6 +13220,7 @@ "content": { "application/json": { "schema": { + "title": "ListAvailablePhoneNumberLocalResponse", "type": "object", "properties": { "available_phone_numbers": { @@ -12084,53 +13230,106 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" } }, - "title": "ListAvailablePhoneNumberLocalResponse" + "readEmpty": { + "value": { + "available_phone_numbers": [], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/Local.json" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -12142,10 +13341,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAvailablePhoneNumberLocal", - "x-maturity": [ - "GA" - ] + "operationId": "ListAvailablePhoneNumberLocal" } }, "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/MachineToMachine.json": { @@ -12161,8 +13357,8 @@ "region", "beta" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json" + "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json", + "pathType": "list" }, "get": { "description": "", @@ -12262,6 +13458,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" + } } }, { @@ -12370,6 +13574,7 @@ "content": { "application/json": { "schema": { + "title": "ListAvailablePhoneNumberMachineToMachineResponse", "type": "object", "properties": { "available_phone_numbers": { @@ -12379,53 +13584,106 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" } }, - "title": "ListAvailablePhoneNumberMachineToMachineResponse" + "readEmpty": { + "value": { + "available_phone_numbers": [], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/MachineToMachine.json" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -12437,10 +13695,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAvailablePhoneNumberMachineToMachine", - "x-maturity": [ - "GA" - ] + "operationId": "ListAvailablePhoneNumberMachineToMachine" } }, "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Mobile.json": { @@ -12456,8 +13711,8 @@ "region", "beta" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json" + "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json", + "pathType": "list" }, "get": { "description": "", @@ -12557,6 +13812,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" + } } }, { @@ -12665,6 +13928,7 @@ "content": { "application/json": { "schema": { + "title": "ListAvailablePhoneNumberMobileResponse", "type": "object", "properties": { "available_phone_numbers": { @@ -12674,53 +13938,106 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" } }, - "title": "ListAvailablePhoneNumberMobileResponse" + "readEmpty": { + "value": { + "available_phone_numbers": [], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/Mobile.json" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -12732,10 +14049,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAvailablePhoneNumberMobile", - "x-maturity": [ - "GA" - ] + "operationId": "ListAvailablePhoneNumberMobile" } }, "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/National.json": { @@ -12751,8 +14065,8 @@ "region", "beta" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json" + "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json", + "pathType": "list" }, "get": { "description": "", @@ -12852,6 +14166,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" + } } }, { @@ -12960,6 +14282,7 @@ "content": { "application/json": { "schema": { + "title": "ListAvailablePhoneNumberNationalResponse", "type": "object", "properties": { "available_phone_numbers": { @@ -12969,53 +14292,106 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" } }, - "title": "ListAvailablePhoneNumberNationalResponse" + "readEmpty": { + "value": { + "available_phone_numbers": [], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/National.json" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -13027,10 +14403,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAvailablePhoneNumberNational", - "x-maturity": [ - "GA" - ] + "operationId": "ListAvailablePhoneNumberNational" } }, "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/SharedCost.json": { @@ -13046,8 +14419,8 @@ "region", "beta" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json" + "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json", + "pathType": "list" }, "get": { "description": "", @@ -13147,6 +14520,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" + } } }, { @@ -13255,6 +14636,7 @@ "content": { "application/json": { "schema": { + "title": "ListAvailablePhoneNumberSharedCostResponse", "type": "object", "properties": { "available_phone_numbers": { @@ -13264,53 +14646,106 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" } }, - "title": "ListAvailablePhoneNumberSharedCostResponse" + "readEmpty": { + "value": { + "available_phone_numbers": [], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/SharedCost.json" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -13322,10 +14757,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAvailablePhoneNumberSharedCost", - "x-maturity": [ - "GA" - ] + "operationId": "ListAvailablePhoneNumberSharedCost" } }, "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/TollFree.json": { @@ -13341,8 +14773,8 @@ "region", "beta" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json" + "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json", + "pathType": "list" }, "get": { "description": "", @@ -13442,6 +14874,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" + } } }, { @@ -13550,6 +14990,7 @@ "content": { "application/json": { "schema": { + "title": "ListAvailablePhoneNumberTollFreeResponse", "type": "object", "properties": { "available_phone_numbers": { @@ -13559,53 +15000,106 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" } }, - "title": "ListAvailablePhoneNumberTollFreeResponse" + "readEmpty": { + "value": { + "available_phone_numbers": [], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/TollFree.json" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -13617,10 +15111,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAvailablePhoneNumberTollFree", - "x-maturity": [ - "GA" - ] + "operationId": "ListAvailablePhoneNumberTollFree" } }, "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Voip.json": { @@ -13636,8 +15127,8 @@ "region", "beta" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json" + "parent": "/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json", + "pathType": "list" }, "get": { "description": "", @@ -13737,6 +15228,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" + } } }, { @@ -13845,6 +15344,7 @@ "content": { "application/json": { "schema": { + "title": "ListAvailablePhoneNumberVoipResponse", "type": "object", "properties": { "available_phone_numbers": { @@ -13854,53 +15354,106 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" } }, - "title": "ListAvailablePhoneNumberVoipResponse" + "readEmpty": { + "value": { + "available_phone_numbers": [], + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AvailablePhoneNumbers/US/Voip.json" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -13912,10 +15465,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAvailablePhoneNumberVoip", - "x-maturity": [ - "GA" - ] + "operationId": "ListAvailablePhoneNumberVoip" } }, "/2010-04-01/Accounts/{AccountSid}/Balance.json": { @@ -13931,8 +15481,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", @@ -13959,6 +15509,51 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.balance" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "balance": "0.05", + "currency": "USD" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -13970,10 +15565,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchBalance", - "x-maturity": [ - "GA" - ] + "operationId": "FetchBalance" } }, "/2010-04-01/Accounts/{AccountSid}/Calls.json": { @@ -13991,7 +15583,6 @@ "status", "start_time" ], - "pathType": "list", "dependentProperties": { "recordings": { "mapping": { @@ -14050,7 +15641,8 @@ "resource_url": "/2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/UserDefinedMessages.json" } }, - "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", @@ -14077,6 +15669,124 @@ "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", + "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", + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -14089,9 +15799,6 @@ } ], "operationId": "CreateCall", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -14288,6 +15995,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" + } + } } } } @@ -14333,6 +16112,23 @@ "handling": "standard", "deleteSla": 120 } + }, + "examples": { + "readFullPage1": { + "value": "+123456789" + }, + "readFullPage2": { + "value": "+123456789" + }, + "readEmptyDatesGreater": { + "value": "+123456789" + }, + "readEmptyDatesLess": { + "value": "+123456789" + }, + "readEmptyDateFunDateFormats": { + "value": "+123456789" + } } }, { @@ -14348,6 +16144,23 @@ "handling": "standard", "deleteSla": 120 } + }, + "examples": { + "readFullPage1": { + "value": "+987654321" + }, + "readFullPage2": { + "value": "+987654321" + }, + "readEmptyDatesGreater": { + "value": "+987654321" + }, + "readEmptyDatesLess": { + "value": "+987654321" + }, + "readEmptyDateFunDateFormats": { + "value": "+987654321" + } } }, { @@ -14359,6 +16172,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" + } } }, { @@ -14368,6 +16198,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" + } } }, { @@ -14377,6 +16224,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFullPage1": { + "value": "2008-01-02" + }, + "readFullPage2": { + "value": "2008-01-02" + } } }, { @@ -14386,6 +16241,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readEmptyDatesLess": { + "value": "2008-01-02" + }, + "readEmptyDateFunDateFormats": { + "value": "06/11/2019 22:05:25 MST" + } } }, { @@ -14395,6 +16258,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readEmptyDatesGreater": { + "value": "2008-01-02" + } } }, { @@ -14404,6 +16272,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFullPage1": { + "value": "2009-01-02" + }, + "readFullPage2": { + "value": "2009-01-02" + } } }, { @@ -14413,6 +16289,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readEmptyDatesLess": { + "value": "2009-01-02" + }, + "readEmptyDateFunDateFormats": { + "value": "2019-06-11 22:05:25.000" + } } }, { @@ -14422,6 +16306,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readEmptyDatesGreater": { + "value": "2009-01-02" + } } }, { @@ -14457,6 +16346,7 @@ "content": { "application/json": { "schema": { + "title": "ListCallResponse", "type": "object", "properties": { "calls": { @@ -14466,53 +16356,293 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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": { + "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": { + "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": { + "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": { + "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" } }, - "title": "ListCallResponse" + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -14524,10 +16654,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCall", - "x-maturity": [ - "GA" - ] + "operationId": "ListCall" } }, "/2010-04-01/Accounts/{AccountSid}/Calls/{Sid}.json": { @@ -14545,7 +16672,6 @@ "status", "start_time" ], - "pathType": "instance", "dependentProperties": { "recordings": { "mapping": { @@ -14604,7 +16730,8 @@ "resource_url": "/2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/UserDefinedMessages.json" } }, - "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.", @@ -14647,10 +16774,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCall", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCall" }, "get": { "description": "Fetch the call specified by the provided Call SID", @@ -14689,6 +16813,84 @@ "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", + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -14700,10 +16902,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCall", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCall" }, "post": { "description": "Initiates a call redirect or terminates a call", @@ -14742,6 +16941,204 @@ "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", + "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", + "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", + "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", + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -14754,9 +17151,6 @@ } ], "operationId": "UpdateCall", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -14821,12 +17215,50 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -14842,8 +17274,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.", @@ -14908,6 +17340,7 @@ "content": { "application/json": { "schema": { + "title": "ListCallEventResponse", "type": "object", "properties": { "events": { @@ -14917,53 +17350,125 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" } }, - "title": "ListCallEventResponse" + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -14975,10 +17480,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCallEvent", - "x-maturity": [ - "GA" - ] + "operationId": "ListCallEvent" } }, "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Notifications/{Sid}.json": { @@ -14995,8 +17497,8 @@ "error_code", "message_date" ], - "pathType": "instance", - "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json", + "pathType": "instance" }, "get": { "description": "", @@ -15047,6 +17549,65 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -15058,10 +17619,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCallNotification", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCallNotification" } }, "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Notifications.json": { @@ -15078,8 +17636,8 @@ "error_code", "message_date" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Calls/{Sid}.json", + "pathType": "list" }, "get": { "description": "", @@ -15117,6 +17675,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 + } } }, { @@ -15126,6 +17692,14 @@ "schema": { "type": "string", "format": "date" + }, + "examples": { + "readFull": { + "value": "2008-01-02" + }, + "readEmpty": { + "value": "2008-01-02" + } } }, { @@ -15179,6 +17753,7 @@ "content": { "application/json": { "schema": { + "title": "ListCallNotificationResponse", "type": "object", "properties": { "notifications": { @@ -15188,53 +17763,117 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" } }, - "title": "ListCallNotificationResponse" + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -15246,10 +17885,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCallNotification", - "x-maturity": [ - "GA" - ] + "operationId": "ListCallNotification" } }, "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Recordings.json": { @@ -15267,8 +17903,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", @@ -15307,6 +17943,66 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -15319,9 +18015,6 @@ } ], "operationId": "CreateCallRecording", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -15363,12 +18056,26 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -15408,6 +18115,14 @@ "schema": { "type": "string", "format": "date" + }, + "examples": { + "readFull": { + "value": "2008-01-02" + }, + "readEmpty": { + "value": "2008-01-02" + } } }, { @@ -15417,6 +18132,14 @@ "schema": { "type": "string", "format": "date" + }, + "examples": { + "readFull": { + "value": "2008-01-01" + }, + "readEmpty": { + "value": "2008-01-01" + } } }, { @@ -15426,6 +18149,14 @@ "schema": { "type": "string", "format": "date" + }, + "examples": { + "readFull": { + "value": "2008-01-03" + }, + "readEmpty": { + "value": "2008-01-03" + } } }, { @@ -15461,6 +18192,7 @@ "content": { "application/json": { "schema": { + "title": "ListCallRecordingResponse", "type": "object", "properties": { "recordings": { @@ -15470,53 +18202,125 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" } }, - "title": "ListCallRecordingResponse" + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -15528,10 +18332,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCallRecording", - "x-maturity": [ - "GA" - ] + "operationId": "ListCallRecording" } }, "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Recordings/{Sid}.json": { @@ -15549,8 +18350,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.", @@ -15598,6 +18399,66 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -15610,9 +18471,6 @@ } ], "operationId": "UpdateCallRecording", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -15633,6 +18491,15 @@ "required": [ "Status" ] + }, + "examples": { + "update": { + "value": { + "Status": "paused", + "PauseBehavior": "skip", + "PlayBeep": true + } + } } } } @@ -15687,6 +18554,70 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -15698,10 +18629,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCallRecording", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCallRecording" }, "delete": { "description": "Delete a recording from your account", @@ -15756,10 +18684,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCallRecording", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCallRecording" } }, "/2010-04-01/Accounts/{AccountSid}/Conferences/{Sid}.json": { @@ -15775,7 +18700,6 @@ "friendly_name", "status" ], - "pathType": "instance", "dependentProperties": { "participants": { "mapping": { @@ -15792,7 +18716,8 @@ "resource_url": "/2010-04-01/Accounts/{account_sid}/Conferences/{conference_sid}/Recordings.json" } }, - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "instance" }, "get": { "description": "Fetch an instance of a conference", @@ -15831,6 +18756,120 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -15842,10 +18881,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConference", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConference" }, "post": { "description": "", @@ -15881,6 +18917,82 @@ "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -15893,9 +19005,6 @@ } ], "operationId": "UpdateConference", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -15923,12 +19032,21 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -15945,7 +19063,6 @@ "friendly_name", "status" ], - "pathType": "list", "dependentProperties": { "participants": { "mapping": { @@ -15962,7 +19079,8 @@ "resource_url": "/2010-04-01/Accounts/{account_sid}/Conferences/{conference_sid}/Recordings.json" } }, - "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", @@ -15989,6 +19107,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" + } } }, { @@ -15998,6 +19130,17 @@ "schema": { "type": "string", "format": "date" + }, + "examples": { + "readEmpty": { + "value": "2008-01-01" + }, + "readNext": { + "value": "2008-01-01" + }, + "readPrevious": { + "value": "2008-01-01" + } } }, { @@ -16007,6 +19150,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" + } } }, { @@ -16016,6 +19173,17 @@ "schema": { "type": "string", "format": "date" + }, + "examples": { + "readEmpty": { + "value": "2018-11-13" + }, + "readNext": { + "value": "2018-11-13" + }, + "readPrevious": { + "value": "2018-11-13" + } } }, { @@ -16025,6 +19193,17 @@ "schema": { "type": "string", "format": "date" + }, + "examples": { + "readEmpty": { + "value": "2018-11-11" + }, + "readNext": { + "value": "2018-11-11" + }, + "readPrevious": { + "value": "2018-11-11" + } } }, { @@ -16034,6 +19213,17 @@ "schema": { "type": "string", "format": "date" + }, + "examples": { + "readEmpty": { + "value": "2018-11-12" + }, + "readNext": { + "value": "2018-11-12" + }, + "readPrevious": { + "value": "2018-11-12" + } } }, { @@ -16042,6 +19232,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" + } } }, { @@ -16051,6 +19255,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" + } } }, { @@ -16086,6 +19304,7 @@ "content": { "application/json": { "schema": { + "title": "ListConferenceResponse", "type": "object", "properties": { "conferences": { @@ -16095,53 +19314,751 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListConference" + } + }, + "/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" + ], + "parent": "/Accounts/{AccountSid}/Conferences/{Sid}.json", + "pathType": "list" + }, + "get": { + "description": "Retrieve a list of recordings belonging to the call used to make the request", + "tags": [ + "Api20100401Recording" + ], + "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": { + "title": "ListConferenceRecordingResponse", + "type": "object", + "properties": { + "recordings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/api.v2010.account.conference.conference_recording" + } + }, + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + } + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/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" } }, - "title": "ListConferenceResponse" + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -16153,10 +20070,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListConference", - "x-maturity": [ - "GA" - ] + "operationId": "ListConferenceRecording" } }, "/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings/{Sid}.json": { @@ -16174,8 +20088,8 @@ "start_time", "duration" ], - "pathType": "instance", - "parent": "/Accounts/{AccountSid}/Conferences/{Sid}.json" + "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.", @@ -16223,6 +20137,65 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -16235,9 +20208,6 @@ } ], "operationId": "UpdateConferenceRecording", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -16258,6 +20228,15 @@ "required": [ "Status" ] + }, + "examples": { + "update": { + "value": { + "Status": "paused", + "PauseBehavior": "skip", + "PlayBeep": true + } + } } } } @@ -16312,6 +20291,69 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -16323,10 +20365,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConferenceRecording", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConferenceRecording" }, "delete": { "description": "Delete a recording from your account", @@ -16381,191 +20420,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", - "tags": [ - "Api20100401Recording" - ], - "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", - "properties": { - "recordings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/api.v2010.account.conference.conference_recording" - } - }, - "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" - }, - "first_page_uri": { - "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" - }, - "next_page_uri": { - "type": "string", - "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" - }, - "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" - }, - "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" - }, - "previous_page_uri": { - "type": "string", - "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" - }, - "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" - }, - "uri": { - "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" - } - }, - "title": "ListConferenceRecordingResponse" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListConferenceRecording", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteConferenceRecording" } }, "/2010-04-01/Accounts/{AccountSid}/ConnectApps/{Sid}.json": { @@ -16580,8 +20435,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", @@ -16620,6 +20475,59 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -16631,10 +20539,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConnectApp", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConnectApp" }, "post": { "description": "Update a connect-app with the specified parameters", @@ -16673,6 +20578,59 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -16685,9 +20643,6 @@ } ], "operationId": "UpdateConnectApp", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -16740,12 +20695,25 @@ "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" + ] + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -16789,10 +20757,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteConnectApp", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteConnectApp" } }, "/2010-04-01/Accounts/{AccountSid}/ConnectApps.json": { @@ -16807,8 +20772,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", @@ -16861,6 +20826,7 @@ "content": { "application/json": { "schema": { + "title": "ListConnectAppResponse", "type": "object", "properties": { "connect_apps": { @@ -16870,53 +20836,114 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json?Page=2&PageSize=50", + "page": 0, + "page_size": 50, + "previous_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json?Page=1&PageSize=50", + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json" } }, - "title": "ListConnectAppResponse" + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -16928,10 +20955,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListConnectApp", - "x-maturity": [ - "GA" - ] + "operationId": "ListConnectApp" } }, "/2010-04-01/Accounts/{AccountSid}/Addresses/{AddressSid}/DependentPhoneNumbers.json": { @@ -16947,8 +20971,8 @@ "phone_number", "friendly_name" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Addresses/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Addresses/{Sid}.json", + "pathType": "list" }, "get": { "description": "", @@ -17013,6 +21037,7 @@ "content": { "application/json": { "schema": { + "title": "ListDependentPhoneNumberResponse", "type": "object", "properties": { "dependent_phone_numbers": { @@ -17022,53 +21047,129 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" } }, - "title": "ListDependentPhoneNumberResponse" + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -17080,10 +21181,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListDependentPhoneNumber", - "x-maturity": [ - "GA" - ] + "operationId": "ListDependentPhoneNumber" } }, "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{Sid}.json": { @@ -17099,7 +21197,6 @@ "phone_number", "friendly_name" ], - "pathType": "instance", "dependentProperties": { "assigned_add_ons": { "mapping": { @@ -17109,7 +21206,8 @@ "resource_url": "/2010-04-01/Accounts/{account_sid}/IncomingPhoneNumbers/{resource_sid}/AssignedAddOns.json" } }, - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "instance" }, "post": { "description": "Update an incoming-phone-number instance.", @@ -17148,6 +21246,90 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -17160,9 +21342,6 @@ } ], "operationId": "UpdateIncomingPhoneNumber", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -17319,12 +21498,37 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -17364,6 +21568,90 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -17375,10 +21663,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.", @@ -17421,10 +21706,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteIncomingPhoneNumber", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteIncomingPhoneNumber" } }, "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers.json": { @@ -17440,7 +21722,6 @@ "phone_number", "friendly_name" ], - "pathType": "list", "dependentProperties": { "assigned_add_ons": { "mapping": { @@ -17450,7 +21731,8 @@ "resource_url": "/2010-04-01/Accounts/{account_sid}/IncomingPhoneNumbers/{resource_sid}/AssignedAddOns.json" } }, - "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.", @@ -17476,6 +21758,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" + } } }, { @@ -17490,6 +21780,14 @@ "handling": "standard", "deleteSla": 30 } + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -17499,6 +21797,14 @@ "schema": { "type": "string", "format": "phone-number" + }, + "examples": { + "readFull": { + "value": "+19876543210" + }, + "readEmpty": { + "value": "+19876543210" + } } }, { @@ -17542,6 +21848,7 @@ "content": { "application/json": { "schema": { + "title": "ListIncomingPhoneNumberResponse", "type": "object", "properties": { "incoming_phone_numbers": { @@ -17551,53 +21858,145 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" } }, - "title": "ListIncomingPhoneNumberResponse" + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -17609,10 +22008,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListIncomingPhoneNumber", - "x-maturity": [ - "GA" - ] + "operationId": "ListIncomingPhoneNumber" }, "post": { "description": "Purchase a phone-number for the account.", @@ -17639,6 +22035,90 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -17651,9 +22131,6 @@ } ], "operationId": "CreateIncomingPhoneNumber", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -17812,6 +22289,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" + } + } } } } @@ -17822,8 +22327,7 @@ "phone_number", "area_code" ] - ], - "addContentTypeIfEmptyForm": true + ] } } }, @@ -17833,7 +22337,7 @@ "url": "https://api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -17841,7 +22345,6 @@ "friendly_name", "description" ], - "pathType": "instance", "dependentProperties": { "extensions": { "mapping": { @@ -17852,7 +22355,8 @@ "resource_url": "/2010-04-01/Accounts/{account_sid}/IncomingPhoneNumbers/{resource_sid}/AssignedAddOns/{assigned_add_on_sid}/Extensions.json" } }, - "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.", @@ -17903,6 +22407,63 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -17914,10 +22475,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchIncomingPhoneNumberAssignedAddOn", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchIncomingPhoneNumberAssignedAddOn" }, "delete": { "description": "Remove the assignment of an Add-on installation from the Number specified.", @@ -17972,10 +22530,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteIncomingPhoneNumberAssignedAddOn", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteIncomingPhoneNumberAssignedAddOn" } }, "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns.json": { @@ -17984,7 +22539,7 @@ "url": "https://api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -17992,7 +22547,6 @@ "friendly_name", "description" ], - "pathType": "list", "dependentProperties": { "extensions": { "mapping": { @@ -18003,7 +22557,8 @@ "resource_url": "/2010-04-01/Accounts/{account_sid}/IncomingPhoneNumbers/{resource_sid}/AssignedAddOns/{assigned_add_on_sid}/Extensions.json" } }, - "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.", @@ -18068,6 +22623,7 @@ "content": { "application/json": { "schema": { + "title": "ListIncomingPhoneNumberAssignedAddOnResponse", "type": "object", "properties": { "assigned_add_ons": { @@ -18077,53 +22633,118 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" } }, - "title": "ListIncomingPhoneNumberAssignedAddOnResponse" + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -18135,10 +22756,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListIncomingPhoneNumberAssignedAddOn", - "x-maturity": [ - "Beta" - ] + "operationId": "ListIncomingPhoneNumberAssignedAddOn" }, "post": { "description": "Assign an Add-on installation to the Number specified.", @@ -18177,6 +22795,63 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -18189,9 +22864,6 @@ } ], "operationId": "CreateIncomingPhoneNumberAssignedAddOn", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -18210,6 +22882,13 @@ "required": [ "InstalledAddOnSid" ] + }, + "examples": { + "create": { + "value": { + "InstalledAddOnSid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -18222,7 +22901,7 @@ "url": "https://api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -18230,9 +22909,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.", @@ -18295,6 +22974,57 @@ "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -18306,10 +23036,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchIncomingPhoneNumberAssignedAddOnExtension", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchIncomingPhoneNumberAssignedAddOnExtension" } }, "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns/{AssignedAddOnSid}/Extensions.json": { @@ -18318,7 +23045,7 @@ "url": "https://api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -18326,9 +23053,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.", @@ -18405,6 +23132,7 @@ "content": { "application/json": { "schema": { + "title": "ListIncomingPhoneNumberAssignedAddOnExtensionResponse", "type": "object", "properties": { "extensions": { @@ -18414,53 +23142,112 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" } }, - "title": "ListIncomingPhoneNumberAssignedAddOnExtensionResponse" + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -18472,10 +23259,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListIncomingPhoneNumberAssignedAddOnExtension", - "x-maturity": [ - "Beta" - ] + "operationId": "ListIncomingPhoneNumberAssignedAddOnExtension" } }, "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/Local.json": { @@ -18491,8 +23275,8 @@ "phone_number", "friendly_name" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/IncomingPhoneNumbers.json" + "parent": "/Accounts/{AccountSid}/IncomingPhoneNumbers.json", + "pathType": "list" }, "get": { "description": "", @@ -18518,6 +23302,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" + } } }, { @@ -18532,6 +23324,14 @@ "handling": "standard", "deleteSla": 30 } + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -18541,6 +23341,14 @@ "schema": { "type": "string", "format": "phone-number" + }, + "examples": { + "readFull": { + "value": "+19876543210" + }, + "readEmpty": { + "value": "+19876543210" + } } }, { @@ -18584,6 +23392,7 @@ "content": { "application/json": { "schema": { + "title": "ListIncomingPhoneNumberLocalResponse", "type": "object", "properties": { "incoming_phone_numbers": { @@ -18593,53 +23402,141 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" } }, - "title": "ListIncomingPhoneNumberLocalResponse" + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -18651,10 +23548,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListIncomingPhoneNumberLocal", - "x-maturity": [ - "GA" - ] + "operationId": "ListIncomingPhoneNumberLocal" }, "post": { "description": "", @@ -18681,6 +23575,87 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -18693,9 +23668,6 @@ } ], "operationId": "CreateIncomingPhoneNumberLocal", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -18853,6 +23825,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" + } + } } } } @@ -18872,8 +23872,8 @@ "phone_number", "friendly_name" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/IncomingPhoneNumbers.json" + "parent": "/Accounts/{AccountSid}/IncomingPhoneNumbers.json", + "pathType": "list" }, "get": { "description": "", @@ -18899,6 +23899,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" + } } }, { @@ -18913,6 +23921,14 @@ "handling": "standard", "deleteSla": 30 } + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -18922,6 +23938,14 @@ "schema": { "type": "string", "format": "phone-number" + }, + "examples": { + "readFull": { + "value": "+19876543210" + }, + "readEmpty": { + "value": "+19876543210" + } } }, { @@ -18965,6 +23989,7 @@ "content": { "application/json": { "schema": { + "title": "ListIncomingPhoneNumberMobileResponse", "type": "object", "properties": { "incoming_phone_numbers": { @@ -18974,53 +23999,141 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" } }, - "title": "ListIncomingPhoneNumberMobileResponse" + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -19032,10 +24145,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListIncomingPhoneNumberMobile", - "x-maturity": [ - "GA" - ] + "operationId": "ListIncomingPhoneNumberMobile" }, "post": { "description": "", @@ -19062,6 +24172,87 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -19074,9 +24265,6 @@ } ], "operationId": "CreateIncomingPhoneNumberMobile", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -19234,6 +24422,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" + } + } } } } @@ -19253,8 +24469,8 @@ "phone_number", "friendly_name" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/IncomingPhoneNumbers.json" + "parent": "/Accounts/{AccountSid}/IncomingPhoneNumbers.json", + "pathType": "list" }, "get": { "description": "", @@ -19280,6 +24496,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" + } } }, { @@ -19294,6 +24518,14 @@ "handling": "standard", "deleteSla": 30 } + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -19303,6 +24535,14 @@ "schema": { "type": "string", "format": "phone-number" + }, + "examples": { + "readFull": { + "value": "+19876543210" + }, + "readEmpty": { + "value": "+19876543210" + } } }, { @@ -19346,6 +24586,7 @@ "content": { "application/json": { "schema": { + "title": "ListIncomingPhoneNumberTollFreeResponse", "type": "object", "properties": { "incoming_phone_numbers": { @@ -19355,53 +24596,141 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" } }, - "title": "ListIncomingPhoneNumberTollFreeResponse" + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -19413,10 +24742,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListIncomingPhoneNumberTollFree", - "x-maturity": [ - "GA" - ] + "operationId": "ListIncomingPhoneNumberTollFree" }, "post": { "description": "", @@ -19443,6 +24769,87 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -19455,9 +24862,6 @@ } ], "operationId": "CreateIncomingPhoneNumberTollFree", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -19615,6 +25019,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" + } + } } } } @@ -19634,8 +25066,8 @@ "friendly_name", "date_created" ], - "pathType": "instance", - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "instance" }, "get": { "description": "", @@ -19674,6 +25106,52 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -19685,10 +25163,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchKey", - "x-maturity": [ - "GA" - ] + "operationId": "FetchKey" }, "post": { "description": "", @@ -19727,6 +25202,52 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -19739,9 +25260,6 @@ } ], "operationId": "UpdateKey", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -19754,12 +25272,16 @@ "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "foo" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -19803,10 +25325,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteKey", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteKey" } }, "/2010-04-01/Accounts/{AccountSid}/Keys.json": { @@ -19822,8 +25341,8 @@ "friendly_name", "date_created" ], - "pathType": "list", - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "list" }, "get": { "description": "", @@ -19876,6 +25395,7 @@ "content": { "application/json": { "schema": { + "title": "ListKeyResponse", "type": "object", "properties": { "keys": { @@ -19885,53 +25405,107 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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 } }, - "title": "ListKeyResponse" + "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -19943,10 +25517,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListKey", - "x-maturity": [ - "GA" - ] + "operationId": "ListKey" }, "post": { "description": "", @@ -19973,6 +25544,53 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -19985,9 +25603,6 @@ } ], "operationId": "CreateNewKey", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -20000,13 +25615,19 @@ "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", - "addContentTypeIfEmptyForm": true + "mountName": "new_keys" } } }, @@ -20023,8 +25644,8 @@ "parent_sid", "content_type" ], - "pathType": "instance", - "parent": "/Accounts/{AccountSid}/Messages/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Messages/{Sid}.json", + "pathType": "instance" }, "delete": { "description": "Delete the Media resource.", @@ -20079,10 +25700,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMedia", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteMedia" }, "get": { "description": "Fetch a single Media resource associated with a specific Message resource", @@ -20133,6 +25751,55 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -20144,10 +25811,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMedia", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMedia" } }, "/2010-04-01/Accounts/{AccountSid}/Messages/{MessageSid}/Media.json": { @@ -20163,8 +25827,8 @@ "parent_sid", "content_type" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Messages/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Messages/{Sid}.json", + "pathType": "list" }, "get": { "description": "Read a list of Media resources associated with a specific Message resource", @@ -20203,6 +25867,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFull": { + "value": "2008-01-02" + }, + "readEmpty": { + "value": "2008-01-02" + } } }, { @@ -20212,6 +25884,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFull": { + "value": "2008-01-01" + }, + "readEmpty": { + "value": "2008-01-01" + } } }, { @@ -20221,6 +25901,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFull": { + "value": "2008-01-03" + }, + "readEmpty": { + "value": "2008-01-03" + } } }, { @@ -20256,6 +25944,7 @@ "content": { "application/json": { "schema": { + "title": "ListMediaResponse", "type": "object", "properties": { "media_list": { @@ -20265,53 +25954,116 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" } }, - "title": "ListMediaResponse" + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -20323,10 +26075,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMedia", - "x-maturity": [ - "GA" - ] + "operationId": "ListMedia" } }, "/2010-04-01/Accounts/{AccountSid}/Queues/{QueueSid}/Members/{CallSid}.json": { @@ -20343,8 +26092,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", @@ -20392,6 +26141,64 @@ "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -20403,10 +26210,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", @@ -20454,6 +26258,64 @@ "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -20466,9 +26328,6 @@ } ], "operationId": "UpdateMember", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -20494,6 +26353,20 @@ "required": [ "Url" ] + }, + "examples": { + "update": { + "value": { + "Method": "GET", + "Url": "https://example.com" + } + }, + "dequeueFront": { + "value": { + "Method": "GET", + "Url": "https://example.com" + } + } } } } @@ -20514,8 +26387,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", @@ -20580,6 +26453,7 @@ "content": { "application/json": { "schema": { + "title": "ListMemberResponse", "type": "object", "properties": { "queue_members": { @@ -20589,53 +26463,109 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" } }, - "title": "ListMemberResponse" + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -20647,10 +26577,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMember", - "x-maturity": [ - "GA" - ] + "operationId": "ListMember" } }, "/2010-04-01/Accounts/{AccountSid}/Messages.json": { @@ -20669,7 +26596,6 @@ "direction", "date_sent" ], - "pathType": "list", "dependentProperties": { "media": { "mapping": { @@ -20686,7 +26612,8 @@ "resource_url": "/2010-04-01/Accounts/{account_sid}/Messages/{message_sid}/Feedback.json" } }, - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "list" }, "post": { "description": "Send a message", @@ -20713,6 +26640,236 @@ "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, 24 Aug 2023 05:01:45 +0000", + "date_sent": "Thu, 24 Aug 2023 05:01:45 +0000", + "date_updated": "Thu, 24 Aug 2023 05:01:45 +0000", + "direction": "outbound-api", + "error_code": null, + "error_message": null, + "from": "+14155552345", + "num_media": "0", + "num_segments": "1", + "price": null, + "price_unit": null, + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "queued", + "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": "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": null, + "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": "queued", + "subresource_uris": { + "media": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json" + }, + "tags": null, + "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": null, + "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": "queued", + "subresource_uris": { + "media": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json" + }, + "tags": null, + "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": "accepted", + "subresource_uris": { + "media": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/MMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json" + }, + "tags": null, + "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": null, + "to": "whatsapp:+15558675310", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -20725,9 +26882,6 @@ } ], "operationId": "CreateMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -20855,6 +27009,100 @@ "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" + ], + "StatusCallback": "https://example.com", + "To": "+14155552345", + "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" + ], + "StatusCallback": "https://example.com", + "To": "+14155552345" + } + }, + "createWithMessagingService": { + "value": { + "ApplicationSid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Body": "Hello! \ud83d\udc4d", + "MessagingServiceSid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "MediaUrl": [ + "https://example.com" + ], + "PersistentAction": [ + "mailto:test@example.com" + ], + "StatusCallback": "https://example.com", + "To": "+14155552345", + "ContentSid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createWithQueuedStatus": { + "value": { + "ApplicationSid": "APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Body": "Hello! \ud83d\udc4d", + "From": "+14155552345", + "MediaUrl": [ + "https://example.com" + ], + "PersistentAction": [ + "mailto:test@example.com" + ], + "StatusCallback": "https://example.com", + "To": "+14155552345" + } + }, + "createScheduledMessageSms": { + "value": { + "Body": "Hello! \ud83d\udc4d", + "MessagingServiceSid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ScheduleType": "fixed", + "StatusCallback": "https://example.com", + "To": "+15558675310" + } + }, + "createScheduledMessageMms": { + "value": { + "Body": "Hello! \ud83d\udc4d", + "MediaUrl": [ + "https://example.com" + ], + "MessagingServiceSid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ScheduleType": "fixed", + "StatusCallback": "https://example.com", + "To": "+15558675310" + } + }, + "createScheduledMessageWhatsapp": { + "value": { + "Body": "Hello! \ud83d\udc4d", + "MessagingServiceSid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ScheduleType": "fixed", + "StatusCallback": "https://example.com", + "To": "94287277+15558675310" + } + } } } } @@ -20904,6 +27152,29 @@ "handling": "standard", "deleteSla": 120 } + }, + "examples": { + "readFullPage1": { + "value": "+123456789" + }, + "readEmptySentdateLess": { + "value": "+123456789" + }, + "readEmptySentdateEquals": { + "value": "+123456789" + }, + "readEmptySentdateGreater": { + "value": "+123456789" + }, + "readEmptySentdateGreaterFormat1": { + "value": "+123456789" + }, + "readEmptySentdateGreaterFormat2": { + "value": "+123456789" + }, + "readEmptySentdateGreaterFormat3": { + "value": "+123456789" + } } }, { @@ -20919,6 +27190,29 @@ "handling": "standard", "deleteSla": 120 } + }, + "examples": { + "readFullPage1": { + "value": "+987654321" + }, + "readEmptySentdateLess": { + "value": "+987654321" + }, + "readEmptySentdateEquals": { + "value": "+987654321" + }, + "readEmptySentdateGreater": { + "value": "+987654321" + }, + "readEmptySentdateGreaterFormat1": { + "value": "+987654321" + }, + "readEmptySentdateGreaterFormat2": { + "value": "+987654321" + }, + "readEmptySentdateGreaterFormat3": { + "value": "+987654321" + } } }, { @@ -20928,6 +27222,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readEmptySentdateEquals": { + "value": "2008-01-02" + } } }, { @@ -20937,6 +27236,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readEmptySentdateLess": { + "value": "2008-01-02" + } } }, { @@ -20946,6 +27250,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" + } } }, { @@ -20981,6 +27302,7 @@ "content": { "application/json": { "schema": { + "title": "ListMessageResponse", "type": "object", "properties": { "messages": { @@ -20990,53 +27312,224 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "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": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "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" } }, - "title": "ListMessageResponse" + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -21048,10 +27541,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMessage", - "x-maturity": [ - "GA" - ] + "operationId": "ListMessage" } }, "/2010-04-01/Accounts/{AccountSid}/Messages/{Sid}.json": { @@ -21070,7 +27560,6 @@ "direction", "date_sent" ], - "pathType": "instance", "dependentProperties": { "media": { "mapping": { @@ -21087,7 +27576,8 @@ "resource_url": "/2010-04-01/Accounts/{account_sid}/Messages/{message_sid}/Feedback.json" } }, - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "instance" }, "delete": { "description": "Deletes a Message resource from your account", @@ -21130,10 +27620,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMessage", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteMessage" }, "get": { "description": "Fetch a specific Message", @@ -21172,6 +27659,75 @@ "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": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -21183,10 +27739,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMessage", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMessage" }, "post": { "description": "Update a Message resource (used to redact Message `body` text and to cancel not-yet-sent messages)", @@ -21225,6 +27778,100 @@ "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": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "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": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -21237,9 +27884,6 @@ } ], "operationId": "UpdateMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -21257,12 +27901,21 @@ "description": "Set as `canceled` to prevent a not-yet-sent Message from being sent. Can be used to cancel sending a [scheduled Message](https://www.twilio.com/docs/messaging/features/message-scheduling) (Messaging Services only)." } } + }, + "examples": { + "redactBody": { + "value": { + "Body": "" + } + }, + "cancelMessage": { + "value": { + "Status": "canceled" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -21279,8 +27932,8 @@ "outcome", "date_created" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Messages/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Messages/{Sid}.json", + "pathType": "list" }, "post": { "description": "Create Message Feedback to confirm a tracked user action was performed by the recipient of the associated Message", @@ -21319,6 +27972,54 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -21331,9 +28032,6 @@ } ], "operationId": "CreateMessageFeedback", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -21347,12 +28045,16 @@ "description": "The outcome to report. Use `confirmed` to indicate that the Message recipient performed the tracked user action. Set `ProvideFeedback`=`true` when [creating a new Message](https://www.twilio.com/docs/sms/api/message-resource#create-a-message-resource) to track Message Feedback. Do not pass `unconfirmed` as the value of the `Outcome` parameter, since it is already the initial value for the MessageFeedback of a newly created Message." } } + }, + "examples": { + "create": { + "value": { + "Outcome": "confirmed" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -21369,8 +28071,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.", @@ -21397,6 +28099,53 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -21409,9 +28158,6 @@ } ], "operationId": "CreateNewSigningKey", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -21424,13 +28170,19 @@ "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", - "addContentTypeIfEmptyForm": true + "mountName": "new_signing_keys" } }, "get": { @@ -21484,6 +28236,7 @@ "content": { "application/json": { "schema": { + "title": "ListSigningKeyResponse", "type": "object", "properties": { "signing_keys": { @@ -21493,53 +28246,107 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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 } }, - "title": "ListSigningKeyResponse" + "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -21551,10 +28358,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSigningKey", - "x-maturity": [ - "GA" - ] + "operationId": "ListSigningKey" } }, "/2010-04-01/Accounts/{AccountSid}/Notifications/{Sid}.json": { @@ -21571,8 +28375,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", @@ -21611,6 +28415,65 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -21622,10 +28485,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchNotification", - "x-maturity": [ - "GA" - ] + "operationId": "FetchNotification" } }, "/2010-04-01/Accounts/{AccountSid}/Notifications.json": { @@ -21642,8 +28502,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", @@ -21669,6 +28529,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 + } } }, { @@ -21678,6 +28546,14 @@ "schema": { "type": "string", "format": "date" + }, + "examples": { + "readFull": { + "value": "2008-01-02" + }, + "readEmpty": { + "value": "2008-01-02" + } } }, { @@ -21731,6 +28607,7 @@ "content": { "application/json": { "schema": { + "title": "ListNotificationResponse", "type": "object", "properties": { "notifications": { @@ -21740,53 +28617,117 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" } }, - "title": "ListNotificationResponse" + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -21798,10 +28739,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListNotification", - "x-maturity": [ - "GA" - ] + "operationId": "ListNotification" } }, "/2010-04-01/Accounts/{AccountSid}/OutgoingCallerIds/{Sid}.json": { @@ -21817,8 +28755,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", @@ -21857,6 +28795,55 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -21868,10 +28855,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchOutgoingCallerId", - "x-maturity": [ - "GA" - ] + "operationId": "FetchOutgoingCallerId" }, "post": { "description": "Updates the caller-id", @@ -21910,6 +28894,55 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -21922,9 +28955,6 @@ } ], "operationId": "UpdateOutgoingCallerId", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -21937,12 +28967,16 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -21986,10 +29020,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteOutgoingCallerId", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteOutgoingCallerId" } }, "/2010-04-01/Accounts/{AccountSid}/OutgoingCallerIds.json": { @@ -22005,8 +29036,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", @@ -22088,6 +29119,7 @@ "content": { "application/json": { "schema": { + "title": "ListOutgoingCallerIdResponse", "type": "object", "properties": { "outgoing_caller_ids": { @@ -22097,53 +29129,110 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" } }, - "title": "ListOutgoingCallerIdResponse" + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -22155,10 +29244,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListOutgoingCallerId", - "x-maturity": [ - "GA" - ] + "operationId": "ListOutgoingCallerId" }, "post": { "description": "", @@ -22185,6 +29271,53 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -22197,9 +29330,6 @@ } ], "operationId": "CreateValidationRequest", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -22242,6 +29372,18 @@ "required": [ "PhoneNumber" ] + }, + "examples": { + "create": { + "value": { + "CallDelay": 100, + "Extension": "extension", + "FriendlyName": "friendly_name", + "PhoneNumber": "+18001234567", + "StatusCallback": "http://www.example.com", + "StatusCallbackMethod": "GET" + } + } } } } @@ -22266,8 +29408,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", @@ -22315,6 +29457,82 @@ "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", + "queue_time": null, + "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", + "queue_time": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -22326,10 +29544,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "FetchParticipant" }, "post": { "description": "Update the properties of the participant", @@ -22377,6 +29592,158 @@ "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, + "queue_time": 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, + "queue_time": 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, + "queue_time": 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, + "queue_time": 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", + "queue_time": null, + "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", + "queue_time": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -22389,9 +29756,6 @@ } ], "operationId": "UpdateParticipant", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -22469,12 +29833,44 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -22527,10 +29923,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteParticipant" } }, "/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants.json": { @@ -22548,8 +29941,8 @@ "muted", "hold" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Conferences/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Conferences/{Sid}.json", + "pathType": "list" }, "post": { "description": "", @@ -22585,6 +29978,253 @@ "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, + "queue_time": "1000", + "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, + "queue_time": "1000", + "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, + "queue_time": "1000", + "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, + "queue_time": "1000", + "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, + "queue_time": "1000", + "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, + "queue_time": "1000", + "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, + "queue_time": "1000", + "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, + "queue_time": "1000", + "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, + "queue_time": "1000", + "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, + "queue_time": "1000", + "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, + "queue_time": "1000", + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -22597,9 +30237,6 @@ } ], "operationId": "CreateParticipant", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -22860,6 +30497,196 @@ "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, + "CallToken": "call-token-string", + "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, + "CallToken": "call-token-string", + "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 + } + } } } } @@ -22901,6 +30728,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" + } } }, { @@ -22909,6 +30747,11 @@ "description": "Whether to return only participants that are on hold. Can be: `true` or `false`.", "schema": { "type": "boolean" + }, + "examples": { + "readEmpty": { + "value": true + } } }, { @@ -22952,6 +30795,7 @@ "content": { "application/json": { "schema": { + "title": "ListParticipantResponse", "type": "object", "properties": { "participants": { @@ -22961,53 +30805,231 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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", + "queue_time": null, + "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, + "queue_time": 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, + "queue_time": 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, + "queue_time": 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 } }, - "title": "ListParticipantResponse" + "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", + "queue_time": null, + "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, + "queue_time": 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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -23019,10 +31041,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "ListParticipant" } }, "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Payments.json": { @@ -23036,8 +31055,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", @@ -23076,6 +31095,54 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -23088,9 +31155,6 @@ } ], "operationId": "CreatePayments", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -23170,6 +31234,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" + } + } } } } @@ -23187,8 +31269,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.", @@ -23239,6 +31321,74 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -23251,9 +31401,6 @@ } ], "operationId": "UpdatePayments", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -23285,6 +31432,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" + } + } } } } @@ -23305,7 +31475,6 @@ "current_size", "average_wait_time" ], - "pathType": "instance", "dependentProperties": { "members": { "mapping": { @@ -23315,7 +31484,8 @@ "resource_url": "/2010-04-01/Accounts/{account_sid}/Queues/{queue_sid}/Members.json" } }, - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "instance" }, "get": { "description": "Fetch an instance of a queue identified by the QueueSid", @@ -23354,6 +31524,60 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -23365,10 +31589,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchQueue", - "x-maturity": [ - "GA" - ] + "operationId": "FetchQueue" }, "post": { "description": "Update the queue with the new parameters", @@ -23407,6 +31628,60 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -23419,9 +31694,6 @@ } ], "operationId": "UpdateQueue", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -23438,12 +31710,17 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -23487,10 +31764,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteQueue", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteQueue" } }, "/2010-04-01/Accounts/{AccountSid}/Queues.json": { @@ -23507,7 +31781,6 @@ "current_size", "average_wait_time" ], - "pathType": "list", "dependentProperties": { "members": { "mapping": { @@ -23517,7 +31790,8 @@ "resource_url": "/2010-04-01/Accounts/{account_sid}/Queues/{queue_sid}/Members.json" } }, - "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", @@ -23570,6 +31844,7 @@ "content": { "application/json": { "schema": { + "title": "ListQueueResponse", "type": "object", "properties": { "queues": { @@ -23579,53 +31854,115 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" } }, - "title": "ListQueueResponse" + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -23637,10 +31974,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListQueue", - "x-maturity": [ - "GA" - ] + "operationId": "ListQueue" }, "post": { "description": "Create a queue", @@ -23667,6 +32001,60 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -23679,9 +32067,6 @@ } ], "operationId": "CreateQueue", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -23701,6 +32086,14 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "MaxSize": 1 + } + } } } } @@ -23722,7 +32115,6 @@ "start_time", "duration" ], - "pathType": "instance", "dependentProperties": { "transcriptions": { "mapping": { @@ -23739,7 +32131,8 @@ "resource_url": "/2010-04-01/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults.json" } }, - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "instance" }, "get": { "description": "Fetch an instance of a recording", @@ -23777,6 +32170,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" + } } } ], @@ -23786,6 +32184,104 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -23797,10 +32293,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRecording", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRecording" }, "delete": { "description": "Delete a recording from your account", @@ -23843,10 +32336,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRecording", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRecording" } }, "/2010-04-01/Accounts/{AccountSid}/Recordings.json": { @@ -23864,7 +32354,6 @@ "start_time", "duration" ], - "pathType": "list", "dependentProperties": { "transcriptions": { "mapping": { @@ -23881,7 +32370,8 @@ "resource_url": "/2010-04-01/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults.json" } }, - "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", @@ -23908,6 +32398,17 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFull": { + "value": "2008-01-02" + }, + "readEmpty": { + "value": "2008-01-02" + }, + "readIncludeSoftDeleted": { + "value": "2008-01-02" + } } }, { @@ -23917,6 +32418,17 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFull": { + "value": "2008-01-01" + }, + "readEmpty": { + "value": "2008-01-01" + }, + "readIncludeSoftDeleted": { + "value": "2008-01-01" + } } }, { @@ -23926,6 +32438,17 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFull": { + "value": "2008-01-03" + }, + "readEmpty": { + "value": "2008-01-03" + }, + "readIncludeSoftDeleted": { + "value": "2008-01-03" + } } }, { @@ -23956,6 +32479,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" + } } }, { @@ -23991,6 +32519,7 @@ "content": { "application/json": { "schema": { + "title": "ListRecordingResponse", "type": "object", "properties": { "recordings": { @@ -24000,53 +32529,199 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" } }, - "title": "ListRecordingResponse" + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=1&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 1, + "previous_page_uri": null, + "recordings": [], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=1&Page=0" + } + }, + "readIncludeSoftDeleted": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=2&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 2, + "previous_page_uri": null, + "recordings": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channels": 2, + "date_created": "Mon, 14 Feb 2022 22:23:00 +0100", + "date_updated": "Mon, 14 Feb 2022 22:23:00 +0100", + "start_time": "Mon, 14 Feb 2022 22:23:00 +0100", + "price": "0.04", + "price_unit": "USD", + "duration": "6", + "sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "source": "OutboundAPI", + "status": "deleted", + "error_code": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json", + "subresource_uris": { + "add_on_results": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json", + "transcriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json" + }, + "encryption_details": { + "encryption_public_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "encryption_cek": "OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q==", + "encryption_iv": "8I2hhNIYNTrwxfHk" + }, + "media_url": "http://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api_version": "2010-04-01", + "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "conference_sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "channels": 2, + "date_created": "Mon, 14 Feb 2022 22:23:00 +0100", + "date_updated": "Mon, 14 Feb 2022 22:23:00 +0100", + "start_time": "Mon, 14 Feb 2022 22:23:00 +0000", + "price": "0.04", + "price_unit": "USD", + "duration": "6", + "sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "source": "OutboundAPI", + "status": "completed", + "error_code": null, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab.json", + "subresource_uris": { + "add_on_results": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/AddOnResults.json", + "transcriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Transcriptions.json" + }, + "encryption_details": { + "encryption_public_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", + "encryption_cek": "OV4h6zrsxMIW7h0Zfqwfn6TI2GCNl54KALlg8wn8YB8KYZhXt6HlgvBWAmQTlfYVeLWydMiCewY0YkDDT1xmNe5huEo9vjuKBS5OmYK4CZkSx1NVv3XOGrZHpd2Pl/5WJHVhUK//AUO87uh5qnUP2E0KoLh1nyCLeGcEkXU0RfpPn/6nxjof/n6m6OzZOyeIRK4Oed5+rEtjqFDfqT0EVKjs6JAxv+f0DCc1xYRHl2yV8bahUPVKs+bHYdy4PVszFKa76M/Uae4jFA9Lv233JqWcxj+K2UoghuGhAFbV/JQIIswY2CBYI8JlVSifSqNEl9vvsTJ8bkVMm3MKbG2P7Q==", + "encryption_iv": "8I2hhNIYNTrwxfHk" + }, + "media_url": "http://api.twilio.com/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json?PageSize=2&Page=0" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -24058,10 +32733,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRecording", - "x-maturity": [ - "GA" - ] + "operationId": "ListRecording" } }, "/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json": { @@ -24078,7 +32750,6 @@ "add_on_sid", "date_created" ], - "pathType": "instance", "dependentProperties": { "payloads": { "mapping": { @@ -24089,7 +32760,8 @@ "resource_url": "/2010-04-01/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults/{add_on_result_sid}/Payloads.json" } }, - "parent": "/Accounts/{AccountSid}/Recordings/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Recordings/{Sid}.json", + "pathType": "instance" }, "get": { "description": "Fetch an instance of an AddOnResult", @@ -24140,6 +32812,60 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result" + }, + "examples": { + "fetch": { + "value": { + "sid": "XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reference_sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "completed", + "add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "add_on_configuration_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "Wed, 01 Sep 2010 15:15:41 +0000", + "date_updated": "Wed, 01 Sep 2010 15:15:41 +0000", + "date_completed": "Wed, 01 Sep 2010 15:15:41 +0000", + "subresource_uris": { + "payloads": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -24151,10 +32877,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRecordingAddOnResult", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRecordingAddOnResult" }, "delete": { "description": "Delete a result and purge all associated Payloads", @@ -24209,10 +32932,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRecordingAddOnResult", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRecordingAddOnResult" } }, "/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults.json": { @@ -24229,7 +32949,6 @@ "add_on_sid", "date_created" ], - "pathType": "list", "dependentProperties": { "payloads": { "mapping": { @@ -24240,7 +32959,8 @@ "resource_url": "/2010-04-01/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults/{add_on_result_sid}/Payloads.json" } }, - "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", @@ -24305,6 +33025,7 @@ "content": { "application/json": { "schema": { + "title": "ListRecordingAddOnResultResponse", "type": "object", "properties": { "add_on_results": { @@ -24314,53 +33035,115 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 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" } }, - "title": "ListRecordingAddOnResultResponse" + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -24372,10 +33155,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRecordingAddOnResult", - "x-maturity": [ - "GA" - ] + "operationId": "ListRecordingAddOnResult" } }, "/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads/{Sid}.json": { @@ -24391,7 +33171,6 @@ "label", "content_type" ], - "pathType": "instance", "dependentProperties": { "data": { "mapping": { @@ -24403,7 +33182,8 @@ "resource_url": "/2010-04-01/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults/{add_on_result_sid}/Payloads/{payload_sid}/Data.json" } }, - "parent": "/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json", + "pathType": "instance" }, "get": { "description": "Fetch an instance of a result payload", @@ -24466,6 +33246,61 @@ "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload" + }, + "examples": { + "fetch": { + "value": { + "sid": "XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reference_sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "add_on_configuration_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "add_on_result_sid": "XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": "XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "content_type": "application/json", + "date_created": "Wed, 01 Sep 2010 15:15:41 +0000", + "date_updated": "Wed, 01 Sep 2010 15:15:41 +0000", + "subresource_uris": { + "data": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads/XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Data.json" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -24477,10 +33312,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRecordingAddOnResultPayload", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRecordingAddOnResultPayload" }, "delete": { "description": "Delete a payload from the result along with all associated Data", @@ -24547,10 +33379,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRecordingAddOnResultPayload", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRecordingAddOnResultPayload" } }, "/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads.json": { @@ -24566,7 +33395,6 @@ "label", "content_type" ], - "pathType": "list", "dependentProperties": { "data": { "mapping": { @@ -24578,7 +33406,8 @@ "resource_url": "/2010-04-01/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults/{add_on_result_sid}/Payloads/{payload_sid}/Data.json" } }, - "parent": "/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json", + "pathType": "list" }, "get": { "description": "Retrieve a list of payloads belonging to the AddOnResult", @@ -24655,6 +33484,7 @@ "content": { "application/json": { "schema": { + "title": "ListRecordingAddOnResultPayloadResponse", "type": "object", "properties": { "payloads": { @@ -24664,53 +33494,116 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "examples": { + "readFull": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "payloads": [ + { + "sid": "XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reference_sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "add_on_configuration_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "add_on_result_sid": "XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "label": "XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "content_type": "application/json", + "date_created": "Wed, 01 Sep 2010 15:15:41 +0000", + "date_updated": "Wed, 01 Sep 2010 15:15:41 +0000", + "subresource_uris": { + "data": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads/XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Data.json" + } + } + ], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0" } }, - "title": "ListRecordingAddOnResultPayloadResponse" + "readEmpty": { + "value": { + "end": 0, + "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0", + "next_page_uri": null, + "page": 0, + "page_size": 50, + "previous_page_uri": null, + "payloads": [], + "start": 0, + "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -24722,10 +33615,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRecordingAddOnResultPayload", - "x-maturity": [ - "GA" - ] + "operationId": "ListRecordingAddOnResultPayload" } }, "/2010-04-01/Accounts/{AccountSid}/Recordings/{RecordingSid}/Transcriptions/{Sid}.json": { @@ -24742,8 +33632,8 @@ "status", "duration" ], - "pathType": "instance", - "parent": "/Accounts/{AccountSid}/Recordings/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Recordings/{Sid}.json", + "pathType": "instance" }, "get": { "description": "", @@ -24794,6 +33684,61 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -24805,10 +33750,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRecordingTranscription", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRecordingTranscription" }, "delete": { "description": "", @@ -24863,10 +33805,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRecordingTranscription", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRecordingTranscription" } }, "/2010-04-01/Accounts/{AccountSid}/Recordings/{RecordingSid}/Transcriptions.json": { @@ -24883,8 +33822,8 @@ "status", "duration" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Recordings/{Sid}.json" + "parent": "/Accounts/{AccountSid}/Recordings/{Sid}.json", + "pathType": "list" }, "get": { "description": "", @@ -24949,6 +33888,7 @@ "content": { "application/json": { "schema": { + "title": "ListRecordingTranscriptionResponse", "type": "object", "properties": { "transcriptions": { @@ -24958,53 +33898,122 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" } }, - "title": "ListRecordingTranscriptionResponse" + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -25016,10 +34025,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRecordingTranscription", - "x-maturity": [ - "GA" - ] + "operationId": "ListRecordingTranscription" } }, "/2010-04-01/Accounts/{AccountSid}/SMS/ShortCodes/{Sid}.json": { @@ -25035,8 +34041,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", @@ -25075,6 +34081,60 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -25086,10 +34146,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchShortCode", - "x-maturity": [ - "GA" - ] + "operationId": "FetchShortCode" }, "post": { "description": "Update a short code with the following parameters", @@ -25128,6 +34185,60 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -25140,9 +34251,6 @@ } ], "operationId": "UpdateShortCode", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -25187,12 +34295,21 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -25209,8 +34326,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", @@ -25236,6 +34353,14 @@ "description": "The string that identifies the ShortCode resources to read.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -25244,6 +34369,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" + } } }, { @@ -25279,6 +34412,7 @@ "content": { "application/json": { "schema": { + "title": "ListShortCodeResponse", "type": "object", "properties": { "short_codes": { @@ -25288,53 +34422,121 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" } }, - "title": "ListShortCodeResponse" + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -25346,10 +34548,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListShortCode", - "x-maturity": [ - "GA" - ] + "operationId": "ListShortCode" } }, "/2010-04-01/Accounts/{AccountSid}/SigningKeys/{Sid}.json": { @@ -25358,14 +34557,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": "", @@ -25404,6 +34603,52 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -25415,10 +34660,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSigningKey", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSigningKey" }, "post": { "description": "", @@ -25457,6 +34699,52 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -25469,9 +34757,6 @@ } ], "operationId": "UpdateSigningKey", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -25484,12 +34769,16 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "foo" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -25533,10 +34822,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSigningKey", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSigningKey" } }, "/2010-04-01/Accounts/{AccountSid}/SIP.json": { @@ -25545,11 +34831,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": { @@ -25558,12 +34844,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": { @@ -25572,12 +34858,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": { @@ -25592,9 +34878,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", @@ -25633,6 +34919,53 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -25645,9 +34978,6 @@ } ], "operationId": "CreateSipAuthCallsCredentialListMapping", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -25666,6 +34996,13 @@ "required": [ "CredentialListSid" ] + }, + "examples": { + "create": { + "value": { + "CredentialListSid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -25734,6 +35071,7 @@ "content": { "application/json": { "schema": { + "title": "ListSipAuthCallsCredentialListMappingResponse", "type": "object", "properties": { "contents": { @@ -25743,53 +35081,108 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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 } }, - "title": "ListSipAuthCallsCredentialListMappingResponse" + "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -25801,10 +35194,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSipAuthCallsCredentialListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "ListSipAuthCallsCredentialListMapping" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings/{Sid}.json": { @@ -25819,9 +35209,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", @@ -25872,6 +35262,53 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -25883,10 +35320,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSipAuthCallsCredentialListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSipAuthCallsCredentialListMapping" }, "delete": { "description": "Delete a credential list mapping from the requested domain", @@ -25941,10 +35375,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSipAuthCallsCredentialListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSipAuthCallsCredentialListMapping" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/IpAccessControlListMappings.json": { @@ -25959,9 +35390,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", @@ -26000,6 +35431,53 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -26012,9 +35490,6 @@ } ], "operationId": "CreateSipAuthCallsIpAccessControlListMapping", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -26033,6 +35508,13 @@ "required": [ "IpAccessControlListSid" ] + }, + "examples": { + "create": { + "value": { + "IpAccessControlListSid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -26101,6 +35583,7 @@ "content": { "application/json": { "schema": { + "title": "ListSipAuthCallsIpAccessControlListMappingResponse", "type": "object", "properties": { "contents": { @@ -26110,53 +35593,108 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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 } }, - "title": "ListSipAuthCallsIpAccessControlListMappingResponse" + "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -26168,10 +35706,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSipAuthCallsIpAccessControlListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "ListSipAuthCallsIpAccessControlListMapping" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/IpAccessControlListMappings/{Sid}.json": { @@ -26186,9 +35721,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", @@ -26239,6 +35774,53 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -26250,10 +35832,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSipAuthCallsIpAccessControlListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSipAuthCallsIpAccessControlListMapping" }, "delete": { "description": "Delete an IP Access Control List mapping from the requested domain", @@ -26308,10 +35887,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSipAuthCallsIpAccessControlListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSipAuthCallsIpAccessControlListMapping" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Registrations.json": { @@ -26320,12 +35896,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": { @@ -26340,9 +35916,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", @@ -26381,6 +35957,53 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -26393,9 +36016,6 @@ } ], "operationId": "CreateSipAuthRegistrationsCredentialListMapping", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -26414,6 +36034,13 @@ "required": [ "CredentialListSid" ] + }, + "examples": { + "create": { + "value": { + "CredentialListSid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -26482,6 +36109,7 @@ "content": { "application/json": { "schema": { + "title": "ListSipAuthRegistrationsCredentialListMappingResponse", "type": "object", "properties": { "contents": { @@ -26491,53 +36119,108 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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 } }, - "title": "ListSipAuthRegistrationsCredentialListMappingResponse" + "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -26549,10 +36232,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSipAuthRegistrationsCredentialListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "ListSipAuthRegistrationsCredentialListMapping" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Registrations/CredentialListMappings/{Sid}.json": { @@ -26567,9 +36247,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", @@ -26620,6 +36300,53 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -26631,10 +36358,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSipAuthRegistrationsCredentialListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSipAuthRegistrationsCredentialListMapping" }, "delete": { "description": "Delete a credential list mapping from the requested domain", @@ -26689,10 +36413,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSipAuthRegistrationsCredentialListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSipAuthRegistrationsCredentialListMapping" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials.json": { @@ -26708,8 +36429,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.", @@ -26774,6 +36495,7 @@ "content": { "application/json": { "schema": { + "title": "ListSipCredentialResponse", "type": "object", "properties": { "credentials": { @@ -26783,53 +36505,110 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" } }, - "title": "ListSipCredentialResponse" + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -26841,10 +36620,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSipCredential", - "x-maturity": [ - "GA" - ] + "operationId": "ListSipCredential" }, "post": { "description": "Create a new credential resource.", @@ -26883,6 +36659,55 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -26895,9 +36720,6 @@ } ], "operationId": "CreateSipCredential", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -26918,6 +36740,14 @@ "Username", "Password" ] + }, + "examples": { + "create": { + "value": { + "Password": "password", + "Username": "username" + } + } } } } @@ -26937,8 +36767,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.", @@ -26989,6 +36819,55 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -27000,10 +36879,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSipCredential", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSipCredential" }, "post": { "description": "Update a credential resource.", @@ -27054,6 +36930,55 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -27066,9 +36991,6 @@ } ], "operationId": "UpdateSipCredential", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -27081,12 +37003,16 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -27142,10 +37068,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSipCredential", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSipCredential" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists.json": { @@ -27160,7 +37083,6 @@ "sid", "friendly_name" ], - "pathType": "list", "dependentProperties": { "credentials": { "mapping": { @@ -27170,7 +37092,8 @@ "resource_url": "/2010-04-01/Accounts/{account_sid}/SIP/CredentialLists/{credential_list_sid}/Credentials.json" } }, - "parent": "/Accounts/{AccountSid}/SIP.json" + "parent": "/Accounts/{AccountSid}/SIP.json", + "pathType": "list" }, "get": { "description": "Get All Credential Lists", @@ -27223,6 +37146,7 @@ "content": { "application/json": { "schema": { + "title": "ListSipCredentialListResponse", "type": "object", "properties": { "credential_lists": { @@ -27232,53 +37156,112 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" } }, - "title": "ListSipCredentialListResponse" + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -27290,10 +37273,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSipCredentialList", - "x-maturity": [ - "GA" - ] + "operationId": "ListSipCredentialList" }, "post": { "description": "Create a Credential List", @@ -27320,6 +37300,57 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -27332,9 +37363,6 @@ } ], "operationId": "CreateSipCredentialList", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -27350,6 +37378,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } @@ -27368,7 +37403,6 @@ "sid", "friendly_name" ], - "pathType": "instance", "dependentProperties": { "credentials": { "mapping": { @@ -27378,7 +37412,8 @@ "resource_url": "/2010-04-01/Accounts/{account_sid}/SIP/CredentialLists/{credential_list_sid}/Credentials.json" } }, - "parent": "/Accounts/{AccountSid}/SIP.json" + "parent": "/Accounts/{AccountSid}/SIP.json", + "pathType": "instance" }, "get": { "description": "Get a Credential List", @@ -27417,6 +37452,57 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -27428,10 +37514,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSipCredentialList", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSipCredentialList" }, "post": { "description": "Update a Credential List", @@ -27470,6 +37553,57 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -27482,9 +37616,6 @@ } ], "operationId": "UpdateSipCredentialList", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -27500,6 +37631,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } @@ -27546,10 +37684,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSipCredentialList", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSipCredentialList" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/CredentialListMappings.json": { @@ -27564,8 +37699,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.", @@ -27604,6 +37739,55 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -27616,9 +37800,6 @@ } ], "operationId": "CreateSipCredentialListMapping", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -27637,6 +37818,13 @@ "required": [ "CredentialListSid" ] + }, + "examples": { + "create": { + "value": { + "CredentialListSid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -27705,6 +37893,7 @@ "content": { "application/json": { "schema": { + "title": "ListSipCredentialListMappingResponse", "type": "object", "properties": { "credential_list_mappings": { @@ -27714,53 +37903,110 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" } }, - "title": "ListSipCredentialListMappingResponse" + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -27772,10 +38018,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSipCredentialListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "ListSipCredentialListMapping" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/CredentialListMappings/{Sid}.json": { @@ -27790,8 +38033,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.", @@ -27842,6 +38085,55 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -27853,10 +38145,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSipCredentialListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSipCredentialListMapping" }, "delete": { "description": "Delete a CredentialListMapping resource from an account.", @@ -27911,10 +38200,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSipCredentialListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSipCredentialListMapping" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains.json": { @@ -27930,7 +38216,6 @@ "domain_name", "friendly_name" ], - "pathType": "list", "dependentProperties": { "ip_access_control_list_mappings": { "mapping": { @@ -27954,7 +38239,8 @@ "resource_url": "/2010-04-01/Accounts/{account_sid}/SIP/Domains/{domain_sid}/Auth.json" } }, - "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", @@ -28007,6 +38293,7 @@ "content": { "application/json": { "schema": { + "title": "ListSipDomainResponse", "type": "object", "properties": { "domains": { @@ -28016,53 +38303,127 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" } }, - "title": "ListSipDomainResponse" + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -28074,10 +38435,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSipDomain", - "x-maturity": [ - "GA" - ] + "operationId": "ListSipDomain" }, "post": { "description": "Create a new Domain", @@ -28104,6 +38462,72 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -28116,9 +38540,6 @@ } ], "operationId": "CreateSipDomain", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -28206,6 +38627,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" + } + } } } } @@ -28225,7 +38665,6 @@ "domain_name", "friendly_name" ], - "pathType": "instance", "dependentProperties": { "ip_access_control_list_mappings": { "mapping": { @@ -28249,7 +38688,8 @@ "resource_url": "/2010-04-01/Accounts/{account_sid}/SIP/Domains/{domain_sid}/Auth.json" } }, - "parent": "/Accounts/{AccountSid}/SIP.json" + "parent": "/Accounts/{AccountSid}/SIP.json", + "pathType": "instance" }, "get": { "description": "Fetch an instance of a Domain", @@ -28288,6 +38728,72 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -28299,10 +38805,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSipDomain", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSipDomain" }, "post": { "description": "Update the attributes of a domain", @@ -28341,6 +38844,72 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -28353,9 +38922,6 @@ } ], "operationId": "UpdateSipDomain", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -28440,12 +39006,28 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -28489,10 +39071,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSipDomain", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSipDomain" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists.json": { @@ -28507,7 +39086,6 @@ "sid", "friendly_name" ], - "pathType": "list", "dependentProperties": { "ip_addresses": { "mapping": { @@ -28517,7 +39095,8 @@ "resource_url": "/2010-04-01/Accounts/{account_sid}/SIP/IpAccessControlLists/{ip_access_control_list_sid}/IpAddresses.json" } }, - "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", @@ -28570,6 +39149,7 @@ "content": { "application/json": { "schema": { + "title": "ListSipIpAccessControlListResponse", "type": "object", "properties": { "ip_access_control_lists": { @@ -28579,53 +39159,112 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" } }, - "title": "ListSipIpAccessControlListResponse" + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -28637,10 +39276,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSipIpAccessControlList", - "x-maturity": [ - "GA" - ] + "operationId": "ListSipIpAccessControlList" }, "post": { "description": "Create a new IpAccessControlList resource", @@ -28667,6 +39303,57 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -28679,9 +39366,6 @@ } ], "operationId": "CreateSipIpAccessControlList", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -28697,6 +39381,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } @@ -28715,7 +39406,6 @@ "sid", "friendly_name" ], - "pathType": "instance", "dependentProperties": { "ip_addresses": { "mapping": { @@ -28725,7 +39415,8 @@ "resource_url": "/2010-04-01/Accounts/{account_sid}/SIP/IpAccessControlLists/{ip_access_control_list_sid}/IpAddresses.json" } }, - "parent": "/Accounts/{AccountSid}/SIP.json" + "parent": "/Accounts/{AccountSid}/SIP.json", + "pathType": "instance" }, "get": { "description": "Fetch a specific instance of an IpAccessControlList", @@ -28764,6 +39455,57 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -28775,10 +39517,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSipIpAccessControlList", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSipIpAccessControlList" }, "post": { "description": "Rename an IpAccessControlList", @@ -28817,6 +39556,57 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -28829,9 +39619,6 @@ } ], "operationId": "UpdateSipIpAccessControlList", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -28847,6 +39634,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } @@ -28893,10 +39687,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSipIpAccessControlList", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSipIpAccessControlList" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/IpAccessControlListMappings/{Sid}.json": { @@ -28911,8 +39702,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.", @@ -28963,6 +39754,55 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -28974,10 +39814,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSipIpAccessControlListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSipIpAccessControlListMapping" }, "delete": { "description": "Delete an IpAccessControlListMapping resource.", @@ -29032,10 +39869,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSipIpAccessControlListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSipIpAccessControlListMapping" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/IpAccessControlListMappings.json": { @@ -29050,8 +39884,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.", @@ -29090,6 +39924,55 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -29102,9 +39985,6 @@ } ], "operationId": "CreateSipIpAccessControlListMapping", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -29123,6 +40003,13 @@ "required": [ "IpAccessControlListSid" ] + }, + "examples": { + "create": { + "value": { + "IpAccessControlListSid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -29191,6 +40078,7 @@ "content": { "application/json": { "schema": { + "title": "ListSipIpAccessControlListMappingResponse", "type": "object", "properties": { "ip_access_control_list_mappings": { @@ -29200,53 +40088,110 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" } }, - "title": "ListSipIpAccessControlListMappingResponse" + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -29258,10 +40203,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSipIpAccessControlListMapping", - "x-maturity": [ - "GA" - ] + "operationId": "ListSipIpAccessControlListMapping" } }, "/2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists/{IpAccessControlListSid}/IpAddresses.json": { @@ -29277,8 +40219,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.", @@ -29343,6 +40285,7 @@ "content": { "application/json": { "schema": { + "title": "ListSipIpAddressResponse", "type": "object", "properties": { "ip_addresses": { @@ -29352,53 +40295,112 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" } }, - "title": "ListSipIpAddressResponse" + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -29410,10 +40412,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSipIpAddress", - "x-maturity": [ - "GA" - ] + "operationId": "ListSipIpAddress" }, "post": { "description": "Create a new IpAddress resource.", @@ -29452,6 +40451,57 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -29464,9 +40514,6 @@ } ], "operationId": "CreateSipIpAddress", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -29491,6 +40538,15 @@ "FriendlyName", "IpAddress" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "IpAddress": "192.168.1.1", + "CidrPrefixLength": 32 + } + } } } } @@ -29510,8 +40566,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.", @@ -29562,6 +40618,57 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -29573,10 +40680,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSipIpAddress", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSipIpAddress" }, "post": { "description": "Update an IpAddress resource.", @@ -29627,6 +40731,57 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -29639,9 +40794,6 @@ } ], "operationId": "UpdateSipIpAddress", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -29662,12 +40814,18 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -29723,10 +40881,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSipIpAddress", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSipIpAddress" } }, "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Siprec.json": { @@ -29741,8 +40896,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", @@ -29781,6 +40936,66 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -29793,9 +41008,6 @@ } ], "operationId": "CreateSiprec", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -30623,12 +41835,29 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -30644,8 +41873,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", @@ -30693,6 +41922,66 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -30705,9 +41994,6 @@ } ], "operationId": "UpdateSiprec", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -30724,6 +42010,18 @@ "required": [ "Status" ] + }, + "examples": { + "updateBySid": { + "value": { + "Status": "stopped" + } + }, + "updateByName": { + "value": { + "Status": "stopped" + } + } } } } @@ -30742,8 +42040,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", @@ -30782,6 +42080,66 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -30794,9 +42152,6 @@ } ], "operationId": "CreateStream", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -31628,6 +42983,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" + } + } } } } @@ -31646,8 +43023,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", @@ -31695,6 +43072,66 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -31707,9 +43144,6 @@ } ], "operationId": "UpdateStream", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -31726,6 +43160,18 @@ "required": [ "Status" ] + }, + "examples": { + "updateBySid": { + "value": { + "Status": "stopped" + } + }, + "updateByName": { + "value": { + "Status": "stopped" + } + } } } } @@ -31744,8 +43190,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", @@ -31772,6 +43218,74 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -31784,9 +43298,6 @@ } ], "operationId": "CreateToken", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -31799,12 +43310,16 @@ "description": "The duration in seconds for which the generated credentials are valid. The default value is 86400 (24 hours)." } } + }, + "examples": { + "create": { + "value": { + "Ttl": 1 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -31822,8 +43337,8 @@ "status", "duration" ], - "pathType": "instance", - "parent": "/Accounts/{Sid}.json" + "parent": "/Accounts/{Sid}.json", + "pathType": "instance" }, "get": { "description": "Fetch an instance of a Transcription", @@ -31862,6 +43377,61 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -31873,10 +43443,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTranscription", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTranscription" }, "delete": { "description": "Delete a transcription from the account used to make the request", @@ -31919,10 +43486,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteTranscription", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteTranscription" } }, "/2010-04-01/Accounts/{AccountSid}/Transcriptions.json": { @@ -31939,8 +43503,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", @@ -31993,6 +43557,7 @@ "content": { "application/json": { "schema": { + "title": "ListTranscriptionResponse", "type": "object", "properties": { "transcriptions": { @@ -32002,53 +43567,122 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" } }, - "title": "ListTranscriptionResponse" + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -32060,10 +43694,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTranscription", - "x-maturity": [ - "GA" - ] + "operationId": "ListTranscription" } }, "/2010-04-01/Accounts/{AccountSid}/Usage.json": { @@ -32072,11 +43703,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": { @@ -32094,8 +43725,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", @@ -32122,6 +43753,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/usage_record_enum_category" + }, + "examples": { + "readFull": { + "value": "calleridlookups" + }, + "readEmpty": { + "value": "calleridlookups" + } } }, { @@ -32131,6 +43770,14 @@ "schema": { "type": "string", "format": "date" + }, + "examples": { + "readFull": { + "value": "2008-01-02" + }, + "readEmpty": { + "value": "2008-01-02" + } } }, { @@ -32140,6 +43787,14 @@ "schema": { "type": "string", "format": "date" + }, + "examples": { + "readFull": { + "value": "2008-01-02" + }, + "readEmpty": { + "value": "2008-01-02" + } } }, { @@ -32183,6 +43838,7 @@ "content": { "application/json": { "schema": { + "title": "ListUsageRecordResponse", "type": "object", "properties": { "usage_records": { @@ -32192,53 +43848,133 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" + } + ] } }, - "title": "ListUsageRecordResponse" + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -32250,10 +43986,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsageRecord", - "x-maturity": [ - "GA" - ] + "operationId": "ListUsageRecord" } }, "/2010-04-01/Accounts/{AccountSid}/Usage/Records/AllTime.json": { @@ -32271,8 +44004,8 @@ "count", "count_unit" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Usage/Records.json" + "parent": "/Accounts/{AccountSid}/Usage/Records.json", + "pathType": "list" }, "get": { "description": "", @@ -32360,6 +44093,7 @@ "content": { "application/json": { "schema": { + "title": "ListUsageRecordAllTimeResponse", "type": "object", "properties": { "usage_records": { @@ -32369,53 +44103,133 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" + } + ] } }, - "title": "ListUsageRecordAllTimeResponse" + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -32427,10 +44241,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsageRecordAllTime", - "x-maturity": [ - "GA" - ] + "operationId": "ListUsageRecordAllTime" } }, "/2010-04-01/Accounts/{AccountSid}/Usage/Records/Daily.json": { @@ -32448,8 +44259,8 @@ "count", "count_unit" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Usage/Records.json" + "parent": "/Accounts/{AccountSid}/Usage/Records.json", + "pathType": "list" }, "get": { "description": "", @@ -32537,6 +44348,7 @@ "content": { "application/json": { "schema": { + "title": "ListUsageRecordDailyResponse", "type": "object", "properties": { "usage_records": { @@ -32546,53 +44358,133 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" + } + ] } }, - "title": "ListUsageRecordDailyResponse" + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -32604,10 +44496,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsageRecordDaily", - "x-maturity": [ - "GA" - ] + "operationId": "ListUsageRecordDaily" } }, "/2010-04-01/Accounts/{AccountSid}/Usage/Records/LastMonth.json": { @@ -32625,8 +44514,8 @@ "count", "count_unit" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Usage/Records.json" + "parent": "/Accounts/{AccountSid}/Usage/Records.json", + "pathType": "list" }, "get": { "description": "", @@ -32714,6 +44603,7 @@ "content": { "application/json": { "schema": { + "title": "ListUsageRecordLastMonthResponse", "type": "object", "properties": { "usage_records": { @@ -32723,53 +44613,133 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" + } + ] } }, - "title": "ListUsageRecordLastMonthResponse" + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -32781,10 +44751,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsageRecordLastMonth", - "x-maturity": [ - "GA" - ] + "operationId": "ListUsageRecordLastMonth" } }, "/2010-04-01/Accounts/{AccountSid}/Usage/Records/Monthly.json": { @@ -32802,8 +44769,8 @@ "count", "count_unit" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Usage/Records.json" + "parent": "/Accounts/{AccountSid}/Usage/Records.json", + "pathType": "list" }, "get": { "description": "", @@ -32891,6 +44858,7 @@ "content": { "application/json": { "schema": { + "title": "ListUsageRecordMonthlyResponse", "type": "object", "properties": { "usage_records": { @@ -32900,53 +44868,133 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" + } + ] } }, - "title": "ListUsageRecordMonthlyResponse" + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -32958,10 +45006,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsageRecordMonthly", - "x-maturity": [ - "GA" - ] + "operationId": "ListUsageRecordMonthly" } }, "/2010-04-01/Accounts/{AccountSid}/Usage/Records/ThisMonth.json": { @@ -32979,8 +45024,8 @@ "count", "count_unit" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Usage/Records.json" + "parent": "/Accounts/{AccountSid}/Usage/Records.json", + "pathType": "list" }, "get": { "description": "", @@ -33068,6 +45113,7 @@ "content": { "application/json": { "schema": { + "title": "ListUsageRecordThisMonthResponse", "type": "object", "properties": { "usage_records": { @@ -33077,53 +45123,133 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" + } + ] } }, - "title": "ListUsageRecordThisMonthResponse" + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -33135,10 +45261,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsageRecordThisMonth", - "x-maturity": [ - "GA" - ] + "operationId": "ListUsageRecordThisMonth" } }, "/2010-04-01/Accounts/{AccountSid}/Usage/Records/Today.json": { @@ -33156,8 +45279,8 @@ "count", "count_unit" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Usage/Records.json" + "parent": "/Accounts/{AccountSid}/Usage/Records.json", + "pathType": "list" }, "get": { "description": "", @@ -33245,6 +45368,7 @@ "content": { "application/json": { "schema": { + "title": "ListUsageRecordTodayResponse", "type": "object", "properties": { "usage_records": { @@ -33254,53 +45378,133 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" + } + ] } }, - "title": "ListUsageRecordTodayResponse" + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -33312,10 +45516,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsageRecordToday", - "x-maturity": [ - "GA" - ] + "operationId": "ListUsageRecordToday" } }, "/2010-04-01/Accounts/{AccountSid}/Usage/Records/Yearly.json": { @@ -33333,8 +45534,8 @@ "count", "count_unit" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Usage/Records.json" + "parent": "/Accounts/{AccountSid}/Usage/Records.json", + "pathType": "list" }, "get": { "description": "", @@ -33422,6 +45623,7 @@ "content": { "application/json": { "schema": { + "title": "ListUsageRecordYearlyResponse", "type": "object", "properties": { "usage_records": { @@ -33431,53 +45633,133 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" + } + ] } }, - "title": "ListUsageRecordYearlyResponse" + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -33489,10 +45771,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsageRecordYearly", - "x-maturity": [ - "GA" - ] + "operationId": "ListUsageRecordYearly" } }, "/2010-04-01/Accounts/{AccountSid}/Usage/Records/Yesterday.json": { @@ -33510,8 +45789,8 @@ "count", "count_unit" ], - "pathType": "list", - "parent": "/Accounts/{AccountSid}/Usage/Records.json" + "parent": "/Accounts/{AccountSid}/Usage/Records.json", + "pathType": "list" }, "get": { "description": "", @@ -33599,6 +45878,7 @@ "content": { "application/json": { "schema": { + "title": "ListUsageRecordYesterdayResponse", "type": "object", "properties": { "usage_records": { @@ -33608,53 +45888,133 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" + } + ] } }, - "title": "ListUsageRecordYesterdayResponse" + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -33666,10 +46026,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsageRecordYesterday", - "x-maturity": [ - "GA" - ] + "operationId": "ListUsageRecordYesterday" } }, "/2010-04-01/Accounts/{AccountSid}/Usage/Triggers/{Sid}.json": { @@ -33686,8 +46043,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", @@ -33726,6 +46083,64 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -33737,10 +46152,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUsageTrigger", - "x-maturity": [ - "GA" - ] + "operationId": "FetchUsageTrigger" }, "post": { "description": "Update an instance of a usage trigger", @@ -33779,6 +46191,64 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -33791,9 +46261,6 @@ } ], "operationId": "UpdateUsageTrigger", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -33820,12 +46287,18 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -33869,10 +46342,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUsageTrigger", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteUsageTrigger" } }, "/2010-04-01/Accounts/{AccountSid}/Usage/Triggers.json": { @@ -33889,8 +46359,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", @@ -33917,6 +46387,64 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -33929,9 +46457,6 @@ } ], "operationId": "CreateUsageTrigger", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -33982,6 +46507,19 @@ "TriggerValue", "UsageCategory" ] + }, + "examples": { + "create": { + "value": { + "CallbackMethod": "GET", + "CallbackUrl": "https://example.com", + "FriendlyName": "friendly_name", + "Recurring": "daily", + "TriggerBy": "count", + "TriggerValue": "trigger_value", + "UsageCategory": "calleridlookups" + } + } } } } @@ -34012,6 +46550,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/usage_trigger_enum_recurring" + }, + "examples": { + "readFull": { + "value": "daily" + }, + "readEmpty": { + "value": "daily" + } } }, { @@ -34021,6 +46567,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/usage_trigger_enum_trigger_field" + }, + "examples": { + "readFull": { + "value": "count" + }, + "readEmpty": { + "value": "count" + } } }, { @@ -34030,6 +46584,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/usage_trigger_enum_usage_category" + }, + "examples": { + "readFull": { + "value": "calleridlookups" + }, + "readEmpty": { + "value": "calleridlookups" + } } }, { @@ -34065,6 +46627,7 @@ "content": { "application/json": { "schema": { + "title": "ListUsageTriggerResponse", "type": "object", "properties": { "usage_triggers": { @@ -34074,53 +46637,125 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "type": "string" }, "next_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "type": "string" }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { - "type": "string", "format": "uri", "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "type": "string" }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { - "type": "string", "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "type": "string" + } + } + }, + "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" + } + ] } }, - "title": "ListUsageTriggerResponse" + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -34132,10 +46767,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsageTrigger", - "x-maturity": [ - "GA" - ] + "operationId": "ListUsageTrigger" } }, "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/UserDefinedMessages.json": { @@ -34149,8 +46781,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.", @@ -34189,6 +46821,52 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -34201,9 +46879,6 @@ } ], "operationId": "CreateUserDefinedMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -34223,6 +46898,14 @@ "required": [ "Content" ] + }, + "examples": { + "create": { + "value": { + "Content": "{\"key\":\"value\"}", + "IdempotencyKey": "1" + } + } } } } @@ -34240,8 +46923,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.", @@ -34280,6 +46963,53 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -34292,9 +47022,6 @@ } ], "operationId": "CreateUserDefinedMessageSubscription", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -34324,6 +47051,15 @@ "required": [ "Callback" ] + }, + "examples": { + "create": { + "value": { + "Callback": "http://www.example.com", + "Method": "POST", + "IdempotencyKey": "1" + } + } } } } @@ -34341,8 +47077,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.", @@ -34397,75 +47133,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUserDefinedMessageSubscription", - "x-maturity": [ - "GA" - ] - } - }, - "/healthcheck": { - "x-twilio": { - "className": "health_check", - "libraryVisibility": "private", - "docs_visibility": "private", - "pathType": "instance", - "x-skip-path": "true" - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "get": { - "operationId": "FetchHealthCheck", - "description": "API HealthCheck", - "security": [], - "tags": [ - "Api20100401HealthCheck" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Healthcheck\")", - "type": "object", - "properties": { - "status": { - "description": "HealthCheck status", - "type": "string" - } - } - } - } - } - } - }, - "x-twilio": { - "pathType": "instance", - "fixedResponse": { - "statusCode": 200, - "content": { - "status": "ok" - } - }, - "transactions": [ - { - "name": "validateHealthCheck", - "request": { - "method": "GET", - "url": "https://api.twilio.com/healthcheck.json" - }, - "response": { - "statusCode": 200, - "content": { - "status": "ok" - } - } - } - ] - } + "operationId": "DeleteUserDefinedMessageSubscription" } } }, @@ -34535,6 +47203,9 @@ { "name": "Api20100401Daily" }, + { + "name": "Api20100401Data" + }, { "name": "Api20100401DependentPhoneNumber" }, @@ -34622,6 +47293,9 @@ { "name": "Api20100401Recording" }, + { + "name": "Api20100401Region" + }, { "name": "Api20100401SharedCost" }, @@ -34631,9 +47305,15 @@ { "name": "Api20100401SigningKey" }, + { + "name": "Api20100401Sip" + }, { "name": "Api20100401Siprec" }, + { + "name": "Api20100401SmsMessage" + }, { "name": "Api20100401Stream" }, @@ -34674,18 +47354,9 @@ "name": "Api20100401Yesterday" } ], - "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." - }, + "security": [ { - "name": "Preview", - "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact https://www.twilio.com/help/contact." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_bulkexports_v1.json b/src/services/twilio-api/twilio_bulkexports_v1.json index 52af5a96..0eca5970 100644 --- a/src/services/twilio-api/twilio_bulkexports_v1.json +++ b/src/services/twilio-api/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.56.1" + "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.", @@ -325,6 +325,49 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -336,10 +379,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDay", - "x-maturity": [ - "GA" - ] + "operationId": "FetchDay" } }, "/v1/Exports/{ResourceType}/Days": { @@ -348,7 +388,7 @@ "url": "https://bulkexports.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "friendly_name", @@ -358,8 +398,8 @@ "size", "redirectTo" ], - "pathType": "list", - "parent": "/Exports/{ResourceType}" + "parent": "/Exports/{ResourceType}", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Days for a resource.", @@ -418,16 +458,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -436,21 +478,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" } }, "title": "ListDayResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -462,10 +576,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListDay", - "x-maturity": [ - "GA" - ] + "operationId": "ListDay" } }, "/v1/Exports/{ResourceType}": { @@ -474,10 +585,9 @@ "url": "https://bulkexports.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", "dependentProperties": { "days": { "mapping": { @@ -491,7 +601,8 @@ }, "resource_url": "/v1/Exports/{resource_type}/Jobs" } - } + }, + "pathType": "instance" }, "get": { "description": "Fetch a specific Export.", @@ -515,6 +626,53 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -526,10 +684,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchExport", - "x-maturity": [ - "GA" - ] + "operationId": "FetchExport" } }, "/v1/Exports": { @@ -538,10 +693,9 @@ "url": "https://bulkexports.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "dependentProperties": { "days": { "mapping": { @@ -555,7 +709,8 @@ }, "resource_url": "/v1/Exports/{resource_type}/Jobs" } - } + }, + "pathType": "list" } }, "/v1/Exports/{ResourceType}/Configuration": { @@ -564,7 +719,7 @@ "url": "https://bulkexports.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "enabled", @@ -573,8 +728,8 @@ "webhook_method", "webhook_url" ], - "pathType": "instance", - "mountName": "export_configuration" + "mountName": "export_configuration", + "pathType": "instance" }, "get": { "description": "Fetch a specific Export Configuration.", @@ -598,6 +753,53 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -609,10 +811,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchExportConfiguration", - "x-maturity": [ - "GA" - ] + "operationId": "FetchExportConfiguration" }, "post": { "description": "Update a specific Export Configuration.", @@ -636,6 +835,53 @@ "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": "" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -648,9 +894,6 @@ } ], "operationId": "UpdateExportConfiguration", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -672,12 +915,16 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -687,7 +934,7 @@ "url": "https://bulkexports.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "details", @@ -702,9 +949,9 @@ "webhook_method", "webhook_url" ], - "pathType": "list", "parent": "/Exports/{ResourceType}", - "mountName": "export_custom_jobs" + "mountName": "export_custom_jobs", + "pathType": "list" }, "get": { "description": "", @@ -763,16 +1010,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -781,21 +1030,99 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListExportCustomJobResponse" + }, + "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" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -807,10 +1134,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListExportCustomJob", - "x-maturity": [ - "GA" - ] + "operationId": "ListExportCustomJob" }, "post": { "description": "", @@ -834,6 +1158,59 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -846,9 +1223,6 @@ } ], "operationId": "CreateExportCustomJob", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -886,6 +1260,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" + } + } } } } @@ -898,7 +1284,7 @@ "url": "https://bulkexports.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "details", @@ -913,8 +1299,8 @@ "webhook_method", "webhook_url" ], - "pathType": "instance", - "parent": "/Exports" + "parent": "/Exports", + "pathType": "instance" }, "get": { "description": "", @@ -941,6 +1327,60 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -952,10 +1392,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchJob", - "x-maturity": [ - "GA" - ] + "operationId": "FetchJob" }, "delete": { "description": "", @@ -986,10 +1423,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteJob", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteJob" } }, "/v1/Exports/Jobs": { @@ -998,7 +1432,7 @@ "url": "https://bulkexports.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "details", @@ -1013,8 +1447,8 @@ "webhook_method", "webhook_url" ], - "pathType": "list", - "parent": "/Exports" + "parent": "/Exports", + "pathType": "list" } } }, @@ -1040,10 +1474,9 @@ "name": "BulkexportsV1Job" } ], - "x-maturity": [ + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_chat_v1.json b/src/services/twilio-api/twilio_chat_v1.json index 6c77e738..103802cf 100644 --- a/src/services/twilio-api/twilio_chat_v1.json +++ b/src/services/twilio-api/twilio_chat_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "chat.v1.service.channel": { "type": "object", @@ -857,12 +863,6 @@ "not_participating" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -878,7 +878,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -895,7 +895,6 @@ "unique_name", "friendly_name" ], - "pathType": "instance", "dependentProperties": { "members": { "mapping": { @@ -919,7 +918,8 @@ "resource_url": "/v1/Services/{service_sid}/Channels/{channel_sid}/Invites" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -955,6 +955,67 @@ "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 + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -966,10 +1027,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchChannel", - "x-maturity": [ - "GA" - ] + "operationId": "FetchChannel" }, "delete": { "description": "", @@ -1009,10 +1067,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteChannel", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteChannel" }, "post": { "description": "", @@ -1048,6 +1103,67 @@ "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 + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1060,9 +1176,6 @@ } ], "operationId": "UpdateChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1083,12 +1196,19 @@ "description": "A valid JSON string that contains application-specific data." } } + }, + "examples": { + "update": { + "value": { + "Type": "channel", + "FriendlyName": "friendly_name", + "UniqueName": "unique_name", + "Attributes": "{ \"foo\": \"bar\" }" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -1105,7 +1225,6 @@ "unique_name", "friendly_name" ], - "pathType": "list", "dependentProperties": { "members": { "mapping": { @@ -1129,7 +1248,8 @@ "resource_url": "/v1/Services/{service_sid}/Channels/{channel_sid}/Invites" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -1156,6 +1276,67 @@ "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 + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1168,9 +1349,6 @@ } ], "operationId": "CreateChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1196,12 +1374,19 @@ "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\" }" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -1276,16 +1461,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1294,21 +1481,107 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListChannelResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1320,10 +1593,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListChannel" } }, "/v1/Credentials": { @@ -1389,16 +1659,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1407,21 +1679,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" } }, "title": "ListCredentialResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1433,10 +1780,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCredential", - "x-maturity": [ - "GA" - ] + "operationId": "ListCredential" }, "post": { "description": "", @@ -1449,6 +1793,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1461,9 +1855,6 @@ } ], "operationId": "CreateCredential", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1504,6 +1895,13 @@ "required": [ "Type" ] + }, + "examples": { + "create": { + "value": { + "Type": "apn" + } + } } } } @@ -1550,6 +1948,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1561,10 +2009,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCredential", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCredential" }, "post": { "description": "", @@ -1591,6 +2036,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1603,9 +2098,6 @@ } ], "operationId": "UpdateCredential", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1638,12 +2130,16 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -1675,10 +2171,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCredential", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCredential" } }, "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}": { @@ -1694,8 +2187,8 @@ "identity", "date_created" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -1743,6 +2236,58 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1754,10 +2299,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInvite", - "x-maturity": [ - "GA" - ] + "operationId": "FetchInvite" }, "delete": { "description": "", @@ -1809,10 +2351,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteInvite", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteInvite" } }, "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites": { @@ -1828,8 +2367,8 @@ "identity", "date_created" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -1865,6 +2404,58 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1877,9 +2468,6 @@ } ], "operationId": "CreateInvite", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1902,6 +2490,14 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "identity", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -1949,6 +2545,18 @@ "handling": "standard", "deleteSla": 30 } + }, + "examples": { + "readEmpty": { + "value": [ + "identity" + ] + }, + "readFull": { + "value": [ + "identity" + ] + } } }, { @@ -1993,16 +2601,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2011,37 +2621,111 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListInviteResponse" + }, + "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" - ] - } + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListInvite" + } }, "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}": { "servers": [ @@ -2056,8 +2740,8 @@ "identity", "date_created" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -2105,6 +2789,59 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2116,10 +2853,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMember", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMember" }, "delete": { "description": "", @@ -2171,10 +2905,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMember", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteMember" }, "post": { "description": "", @@ -2222,6 +2953,74 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2234,9 +3033,6 @@ } ], "operationId": "UpdateMember", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2257,12 +3053,21 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -2279,8 +3084,8 @@ "identity", "date_created" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -2316,6 +3121,59 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2328,9 +3186,6 @@ } ], "operationId": "CreateMember", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2353,6 +3208,13 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "Twilio" + } + } } } } @@ -2444,16 +3306,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2462,21 +3326,99 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListMemberResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2488,10 +3430,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMember", - "x-maturity": [ - "GA" - ] + "operationId": "ListMember" } }, "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}": { @@ -2508,8 +3447,8 @@ "to", "date_created" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -2560,6 +3499,61 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2571,10 +3565,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMessage", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMessage" }, "delete": { "description": "", @@ -2629,10 +3620,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMessage", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteMessage" }, "post": { "description": "", @@ -2683,6 +3671,61 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2695,9 +3738,6 @@ } ], "operationId": "UpdateMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2714,12 +3754,16 @@ "description": "A valid JSON string that contains application-specific data." } } + }, + "examples": { + "update": { + "value": { + "Body": "Hello" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -2737,8 +3781,8 @@ "to", "date_created" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -2777,6 +3821,78 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2789,9 +3905,6 @@ } ], "operationId": "CreateMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2815,6 +3928,19 @@ "required": [ "Body" ] + }, + "examples": { + "create": { + "value": { + "Body": "Hello" + } + }, + "createWithAttributes": { + "value": { + "Body": "Hello", + "Attributes": "{\"test\": \"test\"}" + } + } } } } @@ -2901,16 +4027,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2919,21 +4047,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" } }, "title": "ListMessageResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2945,10 +4153,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMessage", - "x-maturity": [ - "GA" - ] + "operationId": "ListMessage" } }, "/v1/Services/{ServiceSid}/Roles/{Sid}": { @@ -2964,8 +4169,8 @@ "friendly_name", "type" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -3004,6 +4209,62 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3015,10 +4276,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRole", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRole" }, "delete": { "description": "", @@ -3061,10 +4319,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRole", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRole" }, "post": { "description": "", @@ -3103,6 +4358,62 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3115,9 +4426,6 @@ } ], "operationId": "UpdateRole", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3136,6 +4444,13 @@ "required": [ "Permission" ] + }, + "examples": { + "update": { + "value": { + "Permission": "sendMessage" + } + } } } } @@ -3155,8 +4470,8 @@ "friendly_name", "type" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -3183,6 +4498,62 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3195,9 +4566,6 @@ } ], "operationId": "CreateRole", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3227,6 +4595,15 @@ "Type", "Permission" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "Type": "channel", + "Permission": "sendMessage" + } + } } } } @@ -3292,16 +4669,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "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,21 +4689,102 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListRoleResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3336,10 +4796,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRole", - "x-maturity": [ - "GA" - ] + "operationId": "ListRole" } }, "/v1/Services/{Sid}": { @@ -3355,7 +4812,6 @@ "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { "channels": { "mapping": { @@ -3375,7 +4831,8 @@ }, "resource_url": "/v1/Services/{service_sid}/Users" } - } + }, + "pathType": "instance" }, "get": { "description": "", @@ -3402,6 +4859,78 @@ "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": {} + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3413,10 +4942,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchService", - "x-maturity": [ - "GA" - ] + "operationId": "FetchService" }, "delete": { "description": "", @@ -3447,10 +4973,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteService", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteService" }, "post": { "description": "", @@ -3477,6 +5000,176 @@ "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" + } + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3489,9 +5182,6 @@ } ], "operationId": "UpdateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3831,12 +5521,87 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -3853,7 +5618,6 @@ "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { "channels": { "mapping": { @@ -3873,7 +5637,8 @@ }, "resource_url": "/v1/Services/{service_sid}/Users" } - } + }, + "pathType": "list" }, "post": { "description": "", @@ -3886,6 +5651,78 @@ "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": {} + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3898,9 +5735,6 @@ } ], "operationId": "CreateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3916,6 +5750,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } @@ -3969,16 +5810,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3987,21 +5830,218 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListServiceResponse" + }, + "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" + } + } + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4013,10 +6053,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListService", - "x-maturity": [ - "GA" - ] + "operationId": "ListService" } }, "/v1/Services/{ServiceSid}/Users/{Sid}": { @@ -4032,7 +6069,6 @@ "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { "user_channels": { "mapping": { @@ -4042,7 +6078,8 @@ "resource_url": "/v1/Services/{service_sid}/Users/{user_sid}/Channels" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -4078,6 +6115,64 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4089,10 +6184,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUser", - "x-maturity": [ - "GA" - ] + "operationId": "FetchUser" }, "delete": { "description": "", @@ -4132,10 +6224,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUser", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteUser" }, "post": { "description": "", @@ -4171,6 +6260,64 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4183,9 +6330,6 @@ } ], "operationId": "UpdateUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4209,12 +6353,18 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -4231,7 +6381,6 @@ "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { "user_channels": { "mapping": { @@ -4241,7 +6390,8 @@ "resource_url": "/v1/Services/{service_sid}/Users/{user_sid}/Channels" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -4268,6 +6418,64 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4280,9 +6488,6 @@ } ], "operationId": "CreateUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4313,6 +6518,16 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "jing", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Attributes": "{\"test\":\"test\"}", + "FriendlyName": "friendly_name" + } + } } } } @@ -4378,16 +6593,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4396,21 +6613,104 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListUserResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4422,10 +6722,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUser", - "x-maturity": [ - "GA" - ] + "operationId": "ListUser" } }, "/v1/Services/{ServiceSid}/Users/{UserSid}/Channels": { @@ -4434,15 +6731,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.", @@ -4513,16 +6810,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4531,21 +6830,99 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListUserChannelResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4557,10 +6934,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUserChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListUserChannel" } } }, @@ -4598,10 +6972,9 @@ "name": "ChatV1UserChannel" } ], - "x-maturity": [ + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_chat_v2.json b/src/services/twilio-api/twilio_chat_v2.json index 7298fdc0..587cb93d 100644 --- a/src/services/twilio-api/twilio_chat_v2.json +++ b/src/services/twilio-api/twilio_chat_v2.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "chat.v2.service.binding": { "type": "object", @@ -1257,12 +1263,6 @@ "false" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -1278,7 +1278,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -1295,8 +1295,8 @@ "endpoint", "identity" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -1387,16 +1387,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1405,21 +1407,107 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListBindingResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1431,10 +1519,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListBinding", - "x-maturity": [ - "GA" - ] + "operationId": "ListBinding" } }, "/v2/Services/{ServiceSid}/Bindings/{Sid}": { @@ -1450,8 +1535,8 @@ "endpoint", "identity" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -1490,6 +1575,67 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1501,10 +1647,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchBinding", - "x-maturity": [ - "GA" - ] + "operationId": "FetchBinding" }, "delete": { "description": "", @@ -1547,10 +1690,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteBinding", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteBinding" } }, "/v2/Services/{ServiceSid}/Channels/{Sid}": { @@ -1566,7 +1706,6 @@ "unique_name", "friendly_name" ], - "pathType": "instance", "dependentProperties": { "members": { "mapping": { @@ -1597,7 +1736,8 @@ "resource_url": "/v2/Services/{service_sid}/Channels/{channel_sid}/Webhooks" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -1633,6 +1773,68 @@ "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 + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1644,10 +1846,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchChannel", - "x-maturity": [ - "GA" - ] + "operationId": "FetchChannel" }, "delete": { "description": "", @@ -1696,10 +1895,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteChannel", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteChannel" }, "post": { "description": "", @@ -1744,6 +1940,68 @@ "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 + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1756,9 +2014,6 @@ } ], "operationId": "UpdateChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1793,12 +2048,22 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -1815,7 +2080,6 @@ "unique_name", "friendly_name" ], - "pathType": "list", "dependentProperties": { "members": { "mapping": { @@ -1846,7 +2110,8 @@ "resource_url": "/v2/Services/{service_sid}/Channels/{channel_sid}/Webhooks" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -1882,6 +2147,68 @@ "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 + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1894,9 +2221,6 @@ } ], "operationId": "CreateChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1936,12 +2260,22 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -2016,16 +2350,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2034,21 +2370,108 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListChannelResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2060,10 +2483,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListChannel" } }, "/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks": { @@ -2078,8 +2498,8 @@ "sid", "configuration" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -2150,16 +2570,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2168,21 +2590,137 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListChannelWebhookResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2194,10 +2732,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListChannelWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "ListChannelWebhook" }, "post": { "description": "", @@ -2233,6 +2768,65 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2245,9 +2839,6 @@ } ], "operationId": "CreateChannelWebhook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2298,6 +2889,20 @@ "required": [ "Type" ] + }, + "examples": { + "create": { + "value": { + "Type": "webhook", + "Configuration.Url": "dummy", + "Configuration.Method": "GET", + "Configuration.Filters": [ + "onMessageSent", + "onChannelDestroyed" + ], + "Configuration.RetryCount": 2 + } + } } } } @@ -2316,8 +2921,8 @@ "sid", "configuration" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -2365,6 +2970,59 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2376,10 +3034,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchChannelWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "FetchChannelWebhook" }, "post": { "description": "", @@ -2427,6 +3082,65 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2439,9 +3153,6 @@ } ], "operationId": "UpdateChannelWebhook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2484,12 +3195,22 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -2542,10 +3263,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteChannelWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteChannelWebhook" } }, "/v2/Credentials": { @@ -2611,16 +3329,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2629,36 +3349,108 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListCredentialResponse" - } - } - }, - "description": "OK" - } + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } }, "security": [ { "accountSid_authToken": [] } ], - "operationId": "ListCredential", - "x-maturity": [ - "GA" - ] + "operationId": "ListCredential" }, "post": { "description": "", @@ -2671,6 +3463,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2683,9 +3525,6 @@ } ], "operationId": "CreateCredential", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2726,6 +3565,13 @@ "required": [ "Type" ] + }, + "examples": { + "create": { + "value": { + "Type": "apn" + } + } } } } @@ -2772,6 +3618,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2783,10 +3679,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCredential", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCredential" }, "post": { "description": "", @@ -2813,6 +3706,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2825,9 +3768,6 @@ } ], "operationId": "UpdateCredential", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2860,12 +3800,16 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -2897,10 +3841,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCredential", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCredential" } }, "/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}": { @@ -2916,8 +3857,8 @@ "identity", "date_created" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -2965,6 +3906,58 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2976,10 +3969,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInvite", - "x-maturity": [ - "GA" - ] + "operationId": "FetchInvite" }, "delete": { "description": "", @@ -3031,10 +4021,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteInvite", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteInvite" } }, "/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites": { @@ -3050,8 +4037,8 @@ "identity", "date_created" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -3087,6 +4074,58 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3099,9 +4138,6 @@ } ], "operationId": "CreateInvite", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3124,6 +4160,14 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "identity", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -3171,6 +4215,18 @@ "handling": "standard", "deleteSla": 30 } + }, + "examples": { + "readEmpty": { + "value": [ + "identity" + ] + }, + "readFull": { + "value": [ + "identity" + ] + } } }, { @@ -3215,16 +4271,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3233,21 +4291,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" } }, "title": "ListInviteResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3259,10 +4394,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListInvite", - "x-maturity": [ - "GA" - ] + "operationId": "ListInvite" } }, "/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}": { @@ -3278,8 +4410,8 @@ "identity", "date_created" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -3324,6 +4456,60 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3335,10 +4521,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMember", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMember" }, "delete": { "description": "", @@ -3396,10 +4579,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMember", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteMember" }, "post": { "description": "", @@ -3453,6 +4633,60 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3465,9 +4699,6 @@ } ], "operationId": "UpdateMember", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3507,12 +4738,21 @@ "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": "{}" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -3529,8 +4769,8 @@ "identity", "date_created" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -3575,6 +4815,60 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3587,9 +4881,6 @@ } ], "operationId": "CreateMember", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3636,6 +4927,14 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "Twilio", + "Attributes": "{}" + } + } } } } @@ -3727,16 +5026,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3745,21 +5046,100 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListMemberResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3771,10 +5151,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMember", - "x-maturity": [ - "GA" - ] + "operationId": "ListMember" } }, "/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}": { @@ -3791,8 +5168,8 @@ "to", "date_created" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -3840,23 +5217,103 @@ "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": { + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchMessage" + }, + "delete": { "description": "", "tags": [ "ChatV2Message" @@ -3915,10 +5372,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMessage", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteMessage" }, "post": { "description": "", @@ -3975,6 +5429,64 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3987,9 +5499,6 @@ } ], "operationId": "UpdateMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4024,12 +5533,21 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -4047,8 +5565,8 @@ "to", "date_created" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -4093,6 +5611,109 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4105,9 +5726,6 @@ } ], "operationId": "CreateMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4149,12 +5767,30 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -4235,16 +5871,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4253,21 +5891,127 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListMessageResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4279,10 +6023,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMessage", - "x-maturity": [ - "GA" - ] + "operationId": "ListMessage" } }, "/v2/Services/{ServiceSid}/Roles/{Sid}": { @@ -4298,8 +6039,8 @@ "friendly_name", "type" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -4338,6 +6079,62 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4349,10 +6146,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRole", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRole" }, "delete": { "description": "", @@ -4395,10 +6189,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRole", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRole" }, "post": { "description": "", @@ -4437,6 +6228,62 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4449,9 +6296,6 @@ } ], "operationId": "UpdateRole", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4470,6 +6314,13 @@ "required": [ "Permission" ] + }, + "examples": { + "update": { + "value": { + "Permission": "sendMessage" + } + } } } } @@ -4489,8 +6340,8 @@ "friendly_name", "type" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -4517,6 +6368,62 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4529,9 +6436,6 @@ } ], "operationId": "CreateRole", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4561,6 +6465,15 @@ "Type", "Permission" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "Type": "channel", + "Permission": "sendMessage" + } + } } } } @@ -4626,16 +6539,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4644,21 +6559,102 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListRoleResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4670,10 +6666,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRole", - "x-maturity": [ - "GA" - ] + "operationId": "ListRole" } }, "/v2/Services/{Sid}": { @@ -4689,7 +6682,6 @@ "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { "channels": { "mapping": { @@ -4715,7 +6707,8 @@ }, "resource_url": "/v2/Services/{service_sid}/Bindings" } - } + }, + "pathType": "instance" }, "get": { "description": "", @@ -4742,6 +6735,84 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4753,10 +6824,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchService", - "x-maturity": [ - "GA" - ] + "operationId": "FetchService" }, "delete": { "description": "", @@ -4787,10 +6855,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteService", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteService" }, "post": { "description": "", @@ -4817,6 +6882,103 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4829,9 +6991,6 @@ } ], "operationId": "UpdateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4983,12 +7142,44 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -5005,7 +7196,6 @@ "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { "channels": { "mapping": { @@ -5031,7 +7221,8 @@ }, "resource_url": "/v2/Services/{service_sid}/Bindings" } - } + }, + "pathType": "list" }, "post": { "description": "", @@ -5044,6 +7235,84 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5056,9 +7325,6 @@ } ], "operationId": "CreateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5074,6 +7340,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } @@ -5127,16 +7400,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5145,21 +7420,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" } }, "title": "ListServiceResponse" + }, + "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" + } + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5171,10 +7549,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListService", - "x-maturity": [ - "GA" - ] + "operationId": "ListService" } }, "/v2/Services/{ServiceSid}/Users/{Sid}": { @@ -5191,7 +7566,6 @@ "identity", "date_created" ], - "pathType": "instance", "dependentProperties": { "user_channels": { "mapping": { @@ -5208,7 +7582,8 @@ "resource_url": "/v2/Services/{service_sid}/Users/{user_sid}/Bindings" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -5244,6 +7619,65 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5255,10 +7689,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUser", - "x-maturity": [ - "GA" - ] + "operationId": "FetchUser" }, "delete": { "description": "", @@ -5298,10 +7729,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUser", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteUser" }, "post": { "description": "", @@ -5346,6 +7774,65 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5358,9 +7845,6 @@ } ], "operationId": "UpdateUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5384,12 +7868,18 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -5407,7 +7897,6 @@ "identity", "date_created" ], - "pathType": "list", "dependentProperties": { "user_channels": { "mapping": { @@ -5424,7 +7913,8 @@ "resource_url": "/v2/Services/{service_sid}/Users/{user_sid}/Bindings" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -5460,6 +7950,65 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5472,9 +8021,6 @@ } ], "operationId": "CreateUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5505,6 +8051,16 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "jing", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Attributes": "{\"test\":\"test\"}", + "FriendlyName": "friendly_name" + } + } } } } @@ -5570,16 +8126,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5588,21 +8146,105 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListUserResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5614,10 +8256,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUser", - "x-maturity": [ - "GA" - ] + "operationId": "ListUser" } }, "/v2/Services/{ServiceSid}/Users/{UserSid}/Bindings": { @@ -5634,9 +8273,9 @@ "identity", "binding_type" ], - "pathType": "list", "parent": "/Services/{ServiceSid}/Users/{Sid}", - "mountName": "user_bindings" + "mountName": "user_bindings", + "pathType": "list" }, "get": { "description": "", @@ -5719,16 +8358,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5737,21 +8378,105 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListUserBindingResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5763,10 +8488,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUserBinding", - "x-maturity": [ - "GA" - ] + "operationId": "ListUserBinding" } }, "/v2/Services/{ServiceSid}/Users/{UserSid}/Bindings/{Sid}": { @@ -5783,9 +8505,9 @@ "identity", "binding_type" ], - "pathType": "instance", "parent": "/Services/{ServiceSid}/Users/{Sid}", - "mountName": "user_bindings" + "mountName": "user_bindings", + "pathType": "instance" }, "get": { "description": "", @@ -5833,6 +8555,65 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5844,10 +8625,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUserBinding", - "x-maturity": [ - "GA" - ] + "operationId": "FetchUserBinding" }, "delete": { "description": "", @@ -5899,10 +8677,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUserBinding", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteUserBinding" } }, "/v2/Services/{ServiceSid}/Users/{UserSid}/Channels": { @@ -5917,9 +8692,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.", @@ -5990,16 +8765,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -6008,21 +8785,102 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListUserChannelResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6034,10 +8892,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUserChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListUserChannel" } }, "/v2/Services/{ServiceSid}/Users/{UserSid}/Channels/{ChannelSid}": { @@ -6052,9 +8907,9 @@ "channel_sid", "status" ], - "pathType": "instance", "parent": "/Services/{ServiceSid}/Users/{Sid}", - "mountName": "user_channels" + "mountName": "user_channels", + "pathType": "instance" }, "get": { "description": "", @@ -6099,6 +8954,62 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6110,10 +9021,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUserChannel", - "x-maturity": [ - "GA" - ] + "operationId": "FetchUserChannel" }, "delete": { "description": "Removes User from selected Channel.", @@ -6171,10 +9079,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUserChannel", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteUserChannel" }, "post": { "description": "", @@ -6219,6 +9124,80 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6231,9 +9210,6 @@ } ], "operationId": "UpdateUserChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6257,12 +9233,21 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } } @@ -6310,10 +9295,9 @@ "name": "ChatV2Webhook" } ], - "x-maturity": [ + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_chat_v3.json b/src/services/twilio-api/twilio_chat_v3.json index fed24a1c..9dc99ac4 100644 --- a/src/services/twilio-api/twilio_chat_v3.json +++ b/src/services/twilio-api/twilio_chat_v3.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "chat.v3.channel": { "type": "object", @@ -130,12 +136,6 @@ "false" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -151,7 +151,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -213,6 +213,62 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -225,9 +281,6 @@ } ], "operationId": "UpdateChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -248,12 +301,17 @@ "description": "The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this channel belongs to." } } + }, + "examples": { + "update": { + "value": { + "Type": "private", + "MessagingServiceSid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -284,10 +342,9 @@ "name": "ChatV3Channel" } ], - "x-maturity": [ + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_content_sdk.json b/src/services/twilio-api/twilio_content_sdk.json new file mode 100644 index 00000000..01c65c0a --- /dev/null +++ b/src/services/twilio-api/twilio_content_sdk.json @@ -0,0 +1,1829 @@ +{ + "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, + "schemas": { + "listItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/listItem" + } + }, + "listItem": { + "type": "object", + "additionalProperties": false, + "properties": { + "id": { + "type": "string" + }, + "item": { + "type": "string" + }, + "description": { + "type": "string" + } + }, + "required": [ + "id", + "item" + ] + }, + "callToActionActions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/callToActionAction" + } + }, + "callToActionActionType": { + "type": "string", + "enum": [ + "URL", + "PHONE_NUMBER" + ] + }, + "callToActionAction": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "$ref": "#/components/schemas/callToActionActionType" + }, + "title": { + "type": "string" + }, + "url": { + "type": "string" + }, + "phone": { + "type": "string" + }, + "id": { + "type": "string" + } + }, + "required": [ + "type", + "title" + ] + }, + "quickReplyActions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/quickReplyAction" + } + }, + "quickReplyActionType": { + "type": "string", + "enum": [ + "QUICK_REPLY" + ] + }, + "quickReplyAction": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "$ref": "#/components/schemas/quickReplyActionType" + }, + "title": { + "type": "string" + }, + "id": { + "type": "string" + } + }, + "required": [ + "type", + "title" + ] + }, + "cardActions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/cardAction" + } + }, + "cardActionType": { + "type": "string", + "enum": [ + "URL", + "PHONE_NUMBER", + "QUICK_REPLY" + ] + }, + "cardAction": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "$ref": "#/components/schemas/cardActionType" + }, + "title": { + "type": "string" + }, + "url": { + "type": "string" + }, + "phone": { + "type": "string" + }, + "id": { + "type": "string" + } + }, + "required": [ + "type", + "title" + ] + }, + "authenticationActions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/authenticationAction" + } + }, + "authenticationActionType": { + "type": "string", + "enum": [ + "COPY_CODE" + ] + }, + "authenticationAction": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "$ref": "#/components/schemas/authenticationActionType" + }, + "copy_code_text": { + "type": "string" + } + }, + "required": [ + "type", + "copy_code_text" + ] + }, + "catalogItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/catalogItem" + } + }, + "catalogItem": { + "type": "object", + "additionalProperties": false, + "properties": { + "id": { + "type": "string" + }, + "section_title": { + "type": "string" + }, + "name": { + "type": "string" + }, + "media_url": { + "type": "string" + }, + "price": { + "type": "number" + }, + "description": { + "type": "string" + } + } + }, + "twilioText": { + "type": "object", + "description": "Type containing only plain text-based content", + "nullable": true, + "additionalProperties": false, + "properties": { + "body": { + "type": "string" + } + }, + "required": [ + "body" + ] + }, + "twilioMedia": { + "type": "object", + "description": "twilio/media is used to send file attachments, or to send long text via MMS in the US and Canada. As such, the twilio/media type must contain at least ONE of text or media content.", + "nullable": true, + "additionalProperties": false, + "properties": { + "body": { + "type": "string" + }, + "media": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "media" + ] + }, + "twilioLocation": { + "type": "object", + "description": "twilio/location type contains a location pin and an optional label, which can be used to enhance delivery notifications or connect recipients to physical experiences you offer.", + "nullable": true, + "additionalProperties": false, + "properties": { + "latitude": { + "type": "number" + }, + "longitude": { + "type": "number" + }, + "label": { + "type": "string" + } + }, + "required": [ + "latitude", + "longitude" + ] + }, + "twilioListPicker": { + "type": "object", + "description": "twilio/list-picker includes a menu of up to 10 options, which offers a simple way for users to make a selection.", + "nullable": true, + "additionalProperties": false, + "properties": { + "body": { + "type": "string" + }, + "button": { + "type": "string" + }, + "items": { + "$ref": "#/components/schemas/listItems" + } + }, + "required": [ + "body", + "button", + "items" + ] + }, + "twilioCallToAction": { + "type": "object", + "description": "twilio/call-to-action buttons let recipients tap to trigger actions such as launching a website or making a phone call.", + "nullable": true, + "additionalProperties": false, + "properties": { + "body": { + "type": "string" + }, + "actions": { + "$ref": "#/components/schemas/callToActionActions" + } + } + }, + "twilioQuickReply": { + "type": "object", + "description": "twilio/quick-reply templates let recipients tap, rather than type, to respond to the message.", + "nullable": true, + "additionalProperties": false, + "properties": { + "body": { + "type": "string" + }, + "actions": { + "$ref": "#/components/schemas/quickReplyActions" + } + }, + "required": [ + "body", + "actions" + ] + }, + "twilioCard": { + "type": "object", + "description": "twilio/card is a structured template which can be used to send a series of related information. It must include a title and at least one additional field.", + "nullable": true, + "additionalProperties": false, + "properties": { + "title": { + "type": "string" + }, + "subtitle": { + "type": "string" + }, + "media": { + "type": "array", + "items": { + "type": "string" + } + }, + "actions": { + "$ref": "#/components/schemas/cardActions" + } + }, + "required": [ + "title" + ] + }, + "whatsappCard": { + "type": "object", + "description": "whatsapp/card is a structured template which can be used to send a series of related information. It must include a body and at least one additional field.", + "nullable": true, + "additionalProperties": false, + "properties": { + "body": { + "type": "string" + }, + "footer": { + "type": "string" + }, + "media": { + "type": "array", + "items": { + "type": "string" + } + }, + "header_text": { + "type": "string" + }, + "actions": { + "$ref": "#/components/schemas/cardActions" + } + }, + "required": [ + "body" + ] + }, + "whatsappAuthentication": { + "type": "object", + "description": "whatsApp/authentication templates let companies deliver WA approved one-time-password button.", + "nullable": true, + "additionalProperties": false, + "properties": { + "add_security_recommendation": { + "type": "boolean" + }, + "code_expiration_minutes": { + "type": "number" + }, + "actions": { + "$ref": "#/components/schemas/authenticationActions" + } + }, + "required": [ + "actions" + ] + }, + "twilioCatalog": { + "type": "object", + "description": "twilio/catalog type lets recipients view list of catalog products, ask questions about products, order products.", + "nullable": true, + "additionalProperties": false, + "properties": { + "title": { + "type": "string" + }, + "body": { + "type": "string" + }, + "subtitle": { + "type": "string" + }, + "id": { + "type": "string" + }, + "items": { + "$ref": "#/components/schemas/catalogItems" + }, + "dynamic_items": { + "type": "string" + } + }, + "required": [ + "body" + ] + }, + "ContentApprovalRequest": { + "type": "object", + "description": "Content approval request body", + "required": [ + "name", + "category" + ], + "properties": { + "name": { + "description": "Name of the template.", + "type": "string" + }, + "category": { + "description": "A WhatsApp recognized template category.", + "type": "string" + } + } + }, + "ContentCreateRequest": { + "type": "object", + "description": "Content creation request body", + "properties": { + "friendly_name": { + "description": "User defined name of the content", + "type": "string" + }, + "variables": { + "description": "Key value pairs of variable name to value", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "language": { + "description": "Language code for the content", + "type": "string" + }, + "types": { + "$ref": "#/components/schemas/types" + } + }, + "required": [ + "language", + "types" + ] + }, + "types": { + "description": "Content types", + "type": "object", + "properties": { + "twilio/text": { + "$ref": "#/components/schemas/twilioText" + }, + "twilio/media": { + "$ref": "#/components/schemas/twilioMedia" + }, + "twilio/location": { + "$ref": "#/components/schemas/twilioLocation" + }, + "twilio/list-picker": { + "$ref": "#/components/schemas/twilioListPicker" + }, + "twilio/call-to-action": { + "$ref": "#/components/schemas/twilioCallToAction" + }, + "twilio/quick-reply": { + "$ref": "#/components/schemas/twilioQuickReply" + }, + "twilio/card": { + "$ref": "#/components/schemas/twilioCard" + }, + "twilio/catalog": { + "$ref": "#/components/schemas/twilioCatalog" + }, + "whatsapp/card": { + "$ref": "#/components/schemas/whatsappCard" + }, + "whatsapp/authentication": { + "$ref": "#/components/schemas/whatsappAuthentication" + } + } + }, + "info": {}, + "content.v1.content.approval_create": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true + }, + "category": { + "type": "string", + "nullable": true + }, + "content_type": { + "type": "string", + "nullable": true + }, + "status": { + "type": "string", + "nullable": true + }, + "rejection_reason": { + "type": "string", + "nullable": true + }, + "allow_category_change": { + "type": "boolean", + "nullable": true + } + } + }, + "content.v1.content.approval_fetch": { + "type": "object", + "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HX[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that that we created to identify the Content resource." + }, + "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/usage/api/account) that created Content resource." + }, + "whatsapp": { + "nullable": true, + "description": "Contains the whatsapp approval information for the Content resource, with fields such as approval status, rejection reason, and category, amongst others." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The URL of the resource, relative to `https://content.twilio.com`." + } + } + }, + "content.v1.content": { + "type": "object", + "properties": { + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HX[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that that we created to identify the Content resource." + }, + "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/usage/api/account) that created Content resource." + }, + "friendly_name": { + "type": "string", + "nullable": true, + "description": "A string name used to describe the Content resource. Not visible to the end recipient." + }, + "language": { + "type": "string", + "nullable": true, + "description": "Two-letter (ISO 639-1) language code (e.g., en) identifying the language the Content resource is in." + }, + "variables": { + "nullable": true, + "description": "Defines the default placeholder values for variables included in the Content resource. e.g. {\"1\": \"Customer_Name\"}." + }, + "types": { + "nullable": true, + "description": "The [Content types](https://www.twilio.com/docs/content-api/content-types-overview) (e.g. twilio/text) for this Content resource." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The URL of the resource, relative to `https://content.twilio.com`." + }, + "links": { + "type": "object", + "format": "uri-map", + "nullable": true, + "description": "A list of links related to the Content resource, such as approval_fetch and approval_create" + } + } + }, + "content.v1.content_and_approvals": { + "type": "object", + "properties": { + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HX[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that that we created to identify the Content resource." + }, + "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/usage/api/account) that created Content resource." + }, + "friendly_name": { + "type": "string", + "nullable": true, + "description": "A string name used to describe the Content resource. Not visible to the end recipient." + }, + "language": { + "type": "string", + "nullable": true, + "description": "Two-letter (ISO 639-1) language code (e.g., en) identifying the language the Content resource is in." + }, + "variables": { + "nullable": true, + "description": "Defines the default placeholder values for variables included in the Content resource. e.g. {\"1\": \"Customer_Name\"}." + }, + "types": { + "nullable": true, + "description": "The [Content types](https://www.twilio.com/docs/content-api/content-types-overview) (e.g. twilio/text) for this Content resource." + }, + "approval_requests": { + "nullable": true, + "description": "The submitted information and approval request status of the Content resource." + } + } + }, + "content.v1.legacy_content": { + "type": "object", + "properties": { + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HX[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that that we created to identify the Content resource." + }, + "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/usage/api/account) that created Content resource." + }, + "friendly_name": { + "type": "string", + "nullable": true, + "description": "A string name used to describe the Content resource. Not visible to the end recipient." + }, + "language": { + "type": "string", + "nullable": true, + "description": "Two-letter (ISO 639-1) language code (e.g., en) identifying the language the Content resource is in." + }, + "variables": { + "nullable": true, + "description": "Defines the default placeholder values for variables included in the Content resource. e.g. {\"1\": \"Customer_Name\"}." + }, + "types": { + "nullable": true, + "description": "The [Content types](https://www.twilio.com/docs/content-api/content-types-overview) (e.g. twilio/text) for this Content resource." + }, + "legacy_template_name": { + "type": "string", + "nullable": true, + "description": "The string name of the legacy content template associated with this Content resource, unique across all template names for its account. Only lowercase letters, numbers and underscores are allowed" + }, + "legacy_body": { + "type": "string", + "nullable": true, + "description": "The string body field of the legacy content template associated with this Content resource" + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The URL of the resource, relative to `https://content.twilio.com`." + } + } + } + } + }, + "info": { + "title": "Twilio - Content", + "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.1.0" + }, + "openapi": "3.0.1", + "paths": { + "/v1/Content/{ContentSid}/ApprovalRequests/whatsapp": { + "servers": [ + { + "url": "https://content.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "account_sid", + "whatsapp" + ], + "parent": "/Content/{Sid}", + "mountName": "approval_create", + "pathType": "list" + }, + "post": { + "description": "", + "tags": [ + "Contentv1ApprovalCreate" + ], + "parameters": [ + { + "name": "ContentSid", + "in": "path", + "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HX[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ContentApprovalRequest" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/content.v1.content.approval_create" + }, + "examples": { + "createApproval": { + "value": { + "name": "tree_fiddy", + "category": "UTILITY", + "content_type": "twilio/location", + "status": "unsubmitted", + "rejection_reason": "", + "allow_category_change": true + } + } + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateContentApprovalRequest" + } + }, + "/v1/Content/{ContentSid}/ApprovalRequests": { + "servers": [ + { + "url": "https://content.twilio.com" + } + ], + "description": "An Approval Fetch resource represents the approval status of a Content resource.", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "account_sid", + "whatsapp" + ], + "parent": "/Content/{Sid}", + "mountName": "approval_fetch", + "pathType": "instance" + }, + "get": { + "description": "Fetch a Content resource's approval status by its unique Content Sid", + "tags": [ + "Contentv1ApprovalFetch" + ], + "parameters": [ + { + "name": "ContentSid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the Content resource whose approval information to fetch.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HX[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "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": "UTILITY", + "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": "FetchApproval" + } + }, + "/v1/Content/{Sid}": { + "servers": [ + { + "url": "https://content.twilio.com" + } + ], + "description": "A Content resource represents rich messaging content.", + "x-twilio": { + "defaultOutputProperties": [ + "date_created", + "date_updated", + "sid", + "account_sid", + "friendly_name", + "language", + "variables", + "types" + ], + "dependentProperties": { + "approval_create": { + "mapping": { + "content_sid": "sid" + }, + "resource_url": "/v1/Content/{content_sid}/ApprovalRequests/whatsapp" + }, + "approval_fetch": { + "mapping": { + "content_sid": "sid" + }, + "resource_url": "/v1/Content/{content_sid}/ApprovalRequests" + } + }, + "mountName": "contents", + "pathType": "instance" + }, + "get": { + "description": "Fetch a Content resource by its unique Content Sid", + "tags": [ + "Contentv1Content" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the Content resource to fetch.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HX[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "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" + }, + "delete": { + "description": "Deletes a Content resource", + "tags": [ + "Contentv1Content" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the Content resource to fetch.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HX[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteContent" + } + }, + "/v1/Content": { + "servers": [ + { + "url": "https://content.twilio.com" + } + ], + "description": "A Content resource represents rich messaging content.", + "x-twilio": { + "defaultOutputProperties": [ + "date_created", + "date_updated", + "sid", + "account_sid", + "friendly_name", + "language", + "variables", + "types" + ], + "dependentProperties": { + "approval_create": { + "mapping": { + "content_sid": "sid" + }, + "resource_url": "/v1/Content/{content_sid}/ApprovalRequests/whatsapp" + }, + "approval_fetch": { + "mapping": { + "content_sid": "sid" + }, + "resource_url": "/v1/Content/{content_sid}/ApprovalRequests" + } + }, + "mountName": "contents", + "pathType": "list" + }, + "post": { + "description": "Create a Content resource", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ContentCreateRequest" + } + } + } + }, + "tags": [ + "Contentv1Content" + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/content.v1.content" + }, + "examples": { + "create": { + "value": { + "sid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "", + "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": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateContent" + }, + "get": { + "description": "Retrieve a list of Contents belonging to the account used to make the request", + "tags": [ + "Contentv1Content" + ], + "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": "ListContentResponse", + "properties": { + "contents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/content.v1.content" + } + }, + "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": { + "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" + } + }, + "/v1/ContentAndApprovals": { + "servers": [ + { + "url": "https://content.twilio.com" + } + ], + "description": "A Content resource represents rich messaging content and its respective approval request status.", + "x-twilio": { + "defaultOutputProperties": [ + "date_created", + "date_updated", + "sid", + "account_sid", + "friendly_name", + "language", + "variables", + "types", + "approval_requests" + ], + "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", + "tags": [ + "Contentv1ContentAndApprovals" + ], + "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": "ListContentAndApprovalsResponse", + "properties": { + "contents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/content.v1.content_and_approvals" + } + }, + "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": { + "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" + } + }, + "/v1/LegacyContent": { + "servers": [ + { + "url": "https://content.twilio.com" + } + ], + "description": "A Legacy Content resource represents legacy rich messaging content.", + "x-twilio": { + "defaultOutputProperties": [ + "date_created", + "date_updated", + "sid", + "account_sid", + "friendly_name", + "language", + "variables", + "types", + "legacy_template_name", + "legacy_body" + ], + "mountName": "legacy_contents", + "pathType": "list" + }, + "get": { + "description": "Retrieve a list of Legacy Contents belonging to the account used to make the request", + "tags": [ + "Contentv1LegacyContent" + ], + "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": "ListLegacyContentResponse", + "properties": { + "contents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/content.v1.legacy_content" + } + }, + "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": { + "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" + } + } + }, + "servers": [ + { + "url": "https://content.twilio.com" + } + ], + "tags": [ + { + "name": "Contentv1ApprovalCreate" + }, + { + "name": "Contentv1ApprovalFetch" + }, + { + "name": "Contentv1Content" + }, + { + "name": "Contentv1ContentAndApprovals" + }, + { + "name": "Contentv1LegacyContent" + } + ] +} \ No newline at end of file diff --git a/src/services/twilio-api/twilio_content_v1.json b/src/services/twilio-api/twilio_content_v1.json index 370434c3..d99d3157 100644 --- a/src/services/twilio-api/twilio_content_v1.json +++ b/src/services/twilio-api/twilio_content_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "content.v1.content.approval_create": { "type": "object", @@ -246,12 +252,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -267,7 +267,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -277,16 +277,113 @@ "url": "https://content.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "account_sid", "whatsapp" ], - "pathType": "list", "parent": "/Content/{Sid}", - "mountName": "approval_create" + "mountName": "approval_create", + "pathType": "list" + }, + "post": { + "description": "", + "tags": [ + "ContentV1ApprovalCreate" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HX[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/content.v1.content.approval_create" + }, + "examples": { + "createApproval": { + "value": { + "name": "tree_fiddy", + "category": "ACCOUNT_UPDATE", + "content_type": "twilio/location", + "status": "unsubmitted", + "rejection_reason": "", + "allow_category_change": true + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateApprovalCreate", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "CreateApprovalCreateRequest", + "properties": {} + } + } + } + } } }, "/v1/Content/{Sid}/ApprovalRequests": { @@ -302,9 +399,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", @@ -331,6 +428,60 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -342,10 +493,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchApprovalFetch", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchApprovalFetch" } }, "/v1/Content/{Sid}": { @@ -366,7 +514,6 @@ "variables", "types" ], - "pathType": "instance", "dependentProperties": { "approval_create": { "mapping": { @@ -381,7 +528,8 @@ "resource_url": "/v1/Content/{sid}/ApprovalRequests" } }, - "mountName": "contents" + "mountName": "contents", + "pathType": "instance" }, "get": { "description": "Fetch a Content resource by its unique Content Sid", @@ -408,6 +556,72 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -419,10 +633,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchContent", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchContent" }, "delete": { "description": "Deletes a Content resource", @@ -453,10 +664,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteContent", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteContent" } }, "/v1/Content": { @@ -477,7 +685,6 @@ "variables", "types" ], - "pathType": "list", "dependentProperties": { "approval_create": { "mapping": { @@ -492,7 +699,109 @@ "resource_url": "/v1/Content/{sid}/ApprovalRequests" } }, - "mountName": "contents" + "mountName": "contents", + "pathType": "list" + }, + "post": { + "description": "Create a Content resource", + "tags": [ + "ContentV1Content" + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/content.v1.content" + }, + "examples": { + "create": { + "value": { + "sid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "", + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateContent", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "CreateContentRequest", + "properties": {} + } + } + } + } }, "get": { "description": "Retrieve a list of Contents belonging to the account used to make the request", @@ -542,16 +851,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -560,21 +871,164 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListContentResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -586,10 +1040,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListContent", - "x-maturity": [ - "Preview" - ] + "operationId": "ListContent" } }, "/v1/ContentAndApprovals": { @@ -611,8 +1062,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", @@ -662,16 +1113,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -680,21 +1133,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" } }, "title": "ListContentAndApprovalsResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -706,10 +1310,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListContentAndApprovals", - "x-maturity": [ - "Preview" - ] + "operationId": "ListContentAndApprovals" } }, "/v1/LegacyContent": { @@ -732,8 +1333,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", @@ -783,16 +1384,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -801,21 +1404,158 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListLegacyContentResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -827,10 +1567,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListLegacyContent", - "x-maturity": [ - "Preview" - ] + "operationId": "ListLegacyContent" } } }, @@ -840,6 +1577,9 @@ } ], "tags": [ + { + "name": "ContentV1ApprovalCreate" + }, { "name": "ContentV1ApprovalFetch" }, @@ -853,10 +1593,9 @@ "name": "ContentV1LegacyContent" } ], - "x-maturity": [ + "security": [ { - "name": "Preview", - "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact https://www.twilio.com/help/contact." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_content_v2.json b/src/services/twilio-api/twilio_content_v2.json new file mode 100644 index 00000000..67196c6a --- /dev/null +++ b/src/services/twilio-api/twilio_content_v2.json @@ -0,0 +1,904 @@ +{ + "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, + "schemas": { + "info": {}, + "content.v1.content.approval_fetch": { + "type": "object", + "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HX[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that that we created to identify the Content resource." + }, + "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/usage/api/account) that created Content resource." + }, + "whatsapp": { + "nullable": true, + "description": "Contains the whatsapp approval information for the Content resource, with fields such as approval status, rejection reason, and category, amongst others." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The URL of the resource, relative to `https://content.twilio.com`." + } + } + }, + "content.v1.content": { + "type": "object", + "properties": { + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HX[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that that we created to identify the Content resource." + }, + "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/usage/api/account) that created Content resource." + }, + "friendly_name": { + "type": "string", + "nullable": true, + "description": "A string name used to describe the Content resource. Not visible to the end recipient." + }, + "language": { + "type": "string", + "nullable": true, + "description": "Two-letter (ISO 639-1) language code (e.g., en) identifying the language the Content resource is in." + }, + "variables": { + "nullable": true, + "description": "Defines the default placeholder values for variables included in the Content resource. e.g. {\"1\": \"Customer_Name\"}." + }, + "types": { + "nullable": true, + "description": "The [Content types](https://www.twilio.com/docs/content/content-types-overview) (e.g. twilio/text) for this Content resource." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The URL of the resource, relative to `https://content.twilio.com`." + }, + "links": { + "type": "object", + "format": "uri-map", + "nullable": true, + "description": "A list of links related to the Content resource, such as approval_fetch and approval_create" + } + } + }, + "content.v1.content_and_approvals": { + "type": "object", + "properties": { + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HX[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that that we created to identify the Content resource." + }, + "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/usage/api/account) that created Content resource." + }, + "friendly_name": { + "type": "string", + "nullable": true, + "description": "A string name used to describe the Content resource. Not visible to the end recipient." + }, + "language": { + "type": "string", + "nullable": true, + "description": "Two-letter (ISO 639-1) language code (e.g., en) identifying the language the Content resource is in." + }, + "variables": { + "nullable": true, + "description": "Defines the default placeholder values for variables included in the Content resource. e.g. {\"1\": \"Customer_Name\"}." + }, + "types": { + "nullable": true, + "description": "The [Content types](https://www.twilio.com/docs/content/content-types-overview) (e.g. twilio/text) for this Content resource." + }, + "approval_requests": { + "nullable": true, + "description": "The submitted information and approval request status of the Content resource." + } + } + }, + "content.v1.legacy_content": { + "type": "object", + "properties": { + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HX[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that that we created to identify the Content resource." + }, + "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/usage/api/account) that created Content resource." + }, + "friendly_name": { + "type": "string", + "nullable": true, + "description": "A string name used to describe the Content resource. Not visible to the end recipient." + }, + "language": { + "type": "string", + "nullable": true, + "description": "Two-letter (ISO 639-1) language code (e.g., en) identifying the language the Content resource is in." + }, + "variables": { + "nullable": true, + "description": "Defines the default placeholder values for variables included in the Content resource. e.g. {\"1\": \"Customer_Name\"}." + }, + "types": { + "nullable": true, + "description": "The [Content types](https://www.twilio.com/docs/content/content-types-overview) (e.g. twilio/text) for this Content resource." + }, + "legacy_template_name": { + "type": "string", + "nullable": true, + "description": "The string name of the legacy content template associated with this Content resource, unique across all template names for its account. Only lowercase letters, numbers and underscores are allowed" + }, + "legacy_body": { + "type": "string", + "nullable": true, + "description": "The string body field of the legacy content template associated with this Content resource" + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The URL of the resource, relative to `https://content.twilio.com`." + } + } + } + } + }, + "info": { + "title": "Twilio - Content", + "description": "This is the public Twilio REST API.", + "termsOfService": "https://www.twilio.com/legal/tos", + "contact": { + "name": "Twilio Support", + "url": "https://support.twilio.com", + "email": "support@twilio.com" + }, + "license": { + "name": "Apache 2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0.html" + }, + "version": "1.0.0" + }, + "openapi": "3.0.1", + "paths": { + "/v2/Content": { + "servers": [ + { + "url": "https://content.twilio.com" + } + ], + "description": "A Content resource represents rich messaging content.", + "x-twilio": { + "defaultOutputProperties": [ + "date_created", + "date_updated", + "sid", + "account_sid", + "friendly_name", + "language", + "variables", + "types" + ], + "dependentProperties": { + "approval_create": { + "mapping": { + "sid": "sid" + }, + "resource_url": "/v1/Content/{sid}/ApprovalRequests/whatsapp" + }, + "approval_fetch": { + "mapping": { + "sid": "sid" + }, + "resource_url": "/v1/Content/{sid}/ApprovalRequests" + } + }, + "mountName": "contents", + "pathType": "list" + }, + "get": { + "description": "Retrieve a list of Contents belonging to the account used to make the request", + "tags": [ + "ContentV2Content" + ], + "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" + } + }, + { + "name": "SortByDate", + "in": "query", + "description": "Whether to sort by ascending or descending date updated", + "schema": { + "type": "string" + } + }, + { + "name": "SortByContentName", + "in": "query", + "description": "Whether to sort by ascending or descending content name", + "schema": { + "type": "string" + } + }, + { + "name": "DateCreatedAfter", + "in": "query", + "description": "Filter by >=[date-time]", + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "name": "DateCreatedBefore", + "in": "query", + "description": "Filter by <=[date-time]", + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "name": "ContentName", + "in": "query", + "description": "Filter by Regex Pattern in content name", + "schema": { + "type": "string" + } + }, + { + "name": "Content", + "in": "query", + "description": "Filter by Regex Pattern in template content", + "schema": { + "type": "string" + } + }, + { + "name": "Language", + "in": "query", + "description": "Filter by array of valid language(s)", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "ContentType", + "in": "query", + "description": "Filter by array of contentType(s)", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "ChannelEligibility", + "in": "query", + "description": "Filter by array of ChannelEligibility(s), where ChannelEligibility=:", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListContentResponse", + "properties": { + "contents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/content.v1.content" + } + }, + "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": { + "contents": [], + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://content.twilio.com/v2/Content?PageSize=10&Page=0", + "previous_page_url": null, + "url": "https://content.twilio.com/v2/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/v2/Content?PageSize=20&Page=0", + "previous_page_url": null, + "url": "https://content.twilio.com/v2/Content?PageSize=20&Page=0", + "next_page_url": null, + "key": "contents" + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListContent" + } + }, + "/v2/ContentAndApprovals": { + "servers": [ + { + "url": "https://content.twilio.com" + } + ], + "description": "A Content resource represents rich messaging content and its respective approval request status.", + "x-twilio": { + "defaultOutputProperties": [ + "date_created", + "date_updated", + "sid", + "account_sid", + "friendly_name", + "language", + "variables", + "types", + "approval_requests" + ], + "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", + "tags": [ + "ContentV2ContentAndApprovals" + ], + "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" + } + }, + { + "name": "SortByDate", + "in": "query", + "description": "Whether to sort by ascending or descending date updated", + "schema": { + "type": "string" + } + }, + { + "name": "SortByContentName", + "in": "query", + "description": "Whether to sort by ascending or descending content name", + "schema": { + "type": "string" + } + }, + { + "name": "DateCreatedAfter", + "in": "query", + "description": "Filter by >=[date-time]", + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "name": "DateCreatedBefore", + "in": "query", + "description": "Filter by <=[date-time]", + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "name": "ContentName", + "in": "query", + "description": "Filter by Regex Pattern in content name", + "schema": { + "type": "string" + } + }, + { + "name": "Content", + "in": "query", + "description": "Filter by Regex Pattern in template content", + "schema": { + "type": "string" + } + }, + { + "name": "Language", + "in": "query", + "description": "Filter by array of valid language(s)", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "ContentType", + "in": "query", + "description": "Filter by array of contentType(s)", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "ChannelEligibility", + "in": "query", + "description": "Filter by array of ChannelEligibility(s), where ChannelEligibility=:", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListContentAndApprovalsResponse", + "properties": { + "contents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/content.v1.content_and_approvals" + } + }, + "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": { + "contents": [], + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://content.twilio.com/v2/ContentAndApprovals?PageSize=10&Page=0", + "previous_page_url": null, + "next_page_url": null, + "url": "https://content.twilio.com/v2/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/v2/ContentAndApprovals?PageSize=20&Page=0", + "url": "https://content.twilio.com/v2/ContentAndApprovals?PageSize=20&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "contents" + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListContentAndApprovals" + } + } + }, + "servers": [ + { + "url": "https://content.twilio.com" + } + ], + "tags": [ + { + "name": "ContentV2Content" + }, + { + "name": "ContentV2ContentAndApprovals" + } + ], + "security": [ + { + "accountSid_authToken": [] + } + ] +} \ No newline at end of file diff --git a/src/services/twilio-api/twilio_conversations_v1.json b/src/services/twilio-api/twilio_conversations_v1.json index 63a79bca..9fbd8fa5 100644 --- a/src/services/twilio-api/twilio_conversations_v1.json +++ b/src/services/twilio-api/twilio_conversations_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "conversations.v1.configuration": { "type": "object", @@ -735,6 +741,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": { @@ -2053,6 +2073,13 @@ "service" ] }, + "service_stats_conversations_ratelimitingerrors_enum_source": { + "type": "string", + "enum": [ + "SDK", + "API" + ] + }, "conversations.v1.service.service_user": { "type": "object", "properties": { @@ -2370,6 +2397,12 @@ "POST" ] }, + "stats_twilsock_ratelimitingerrors_enum_source": { + "type": "string", + "enum": [ + "TWILSOCK" + ] + }, "conversations.v1.user": { "type": "object", "properties": { @@ -2627,12 +2660,6 @@ "closed" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -2648,7 +2675,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -2678,6 +2705,58 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2689,10 +2768,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConfiguration", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConfiguration" }, "post": { "description": "Update the global configuration of conversations on your account", @@ -2705,6 +2781,58 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2717,9 +2845,6 @@ } ], "operationId": "UpdateConfiguration", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2750,12 +2875,19 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -2773,8 +2905,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", @@ -2788,6 +2920,11 @@ "description": "Filter the address configurations by its type. This value can be one of: `whatsapp`, `sms`.", "schema": { "type": "string" + }, + "examples": { + "readByAddressType": { + "value": "sms" + } } }, { @@ -2832,16 +2969,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2850,21 +2989,211 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListConfigurationAddressResponse" + }, + "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" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2876,10 +3205,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListConfigurationAddress", - "x-maturity": [ - "GA" - ] + "operationId": "ListConfigurationAddress" }, "post": { "description": "Create a new address configuration", @@ -2892,6 +3218,85 @@ "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" + } + }, + "createEmail": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address": "example@example.com", + "type": "email", + "friendly_name": "My Email Configuration", + "auto_creation": { + "enabled": true, + "type": "default" + }, + "address_country": null, + "date_created": "2016-03-24T21:05:50Z", + "date_updated": "2016-03-24T21:05:50Z", + "url": "https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2904,9 +3309,6 @@ } ], "operationId": "CreateConfigurationAddress", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2979,6 +3381,34 @@ "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" + } + }, + "createEmail": { + "value": { + "Address": "example@example.com", + "Type": "email", + "FriendlyName": "My Email Configuration", + "AutoCreation.Enabled": true, + "AutoCreation.Type": "default" + } + } } } } @@ -2999,8 +3429,8 @@ "address", "friendly_name" ], - "pathType": "instance", - "mountName": "address_configurations" + "mountName": "address_configurations", + "pathType": "instance" }, "get": { "description": "Fetch an address configuration ", @@ -3024,6 +3454,68 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3035,10 +3527,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConfigurationAddress", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConfigurationAddress" }, "post": { "description": "Update an existing address configuration", @@ -3062,6 +3551,64 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3074,9 +3621,6 @@ } ], "operationId": "UpdateConfigurationAddress", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3132,12 +3676,20 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -3166,10 +3718,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteConfigurationAddress", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteConfigurationAddress" } }, "/v1/Configuration/Webhooks": { @@ -3186,8 +3735,8 @@ "pre_webhook_url", "post_webhook_url" ], - "pathType": "instance", - "parent": "/Configuration" + "parent": "/Configuration", + "pathType": "instance" }, "get": { "description": "", @@ -3200,6 +3749,58 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3211,10 +3812,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConfigurationWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConfigurationWebhook" }, "post": { "description": "", @@ -3227,6 +3825,57 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3239,9 +3888,6 @@ } ], "operationId": "UpdateConfigurationWebhook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3274,12 +3920,22 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -3297,7 +3953,6 @@ "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { "participants": { "mapping": { @@ -3317,7 +3972,8 @@ }, "resource_url": "/v1/Conversations/{conversation_sid}/Webhooks" } - } + }, + "pathType": "list" }, "post": { "description": "Create a new conversation in your account's default service", @@ -3341,6 +3997,118 @@ "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" + } + } + }, + "createEmailConversation": { + "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": { + "email": { + "projected_address": "example+123@example.com", + "name": "example" + } + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3353,9 +4121,6 @@ } ], "operationId": "CreateConversation", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3414,12 +4179,42 @@ "description": "The default name that will be used when sending outbound emails in this conversation." } } + }, + "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" + } + }, + "createEmailConversation": { + "value": { + "FriendlyName": "friendly_name", + "DateCreated": "2020-07-01T22:18:37Z", + "DateUpdated": "2020-07-01T22:18:37Z", + "Bindings.Email.Address": "example@example.com", + "Bindings.Email.Name": "Example" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -3495,16 +4290,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3513,36 +4310,107 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListConversationResponse" + }, + "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": [] + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] } ], - "operationId": "ListConversation", - "x-maturity": [ - "GA" - ] + "operationId": "ListConversation" } }, "/v1/Conversations/{Sid}": { @@ -3559,7 +4427,6 @@ "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { "participants": { "mapping": { @@ -3579,7 +4446,8 @@ }, "resource_url": "/v1/Conversations/{conversation_sid}/Webhooks" } - } + }, + "pathType": "instance" }, "post": { "description": "Update an existing conversation in your account's default service", @@ -3612,6 +4480,69 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3624,9 +4555,6 @@ } ], "operationId": "UpdateConversation", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3685,12 +4613,24 @@ "description": "The default name that will be used when sending outbound emails in this conversation." } } + }, + "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -3728,10 +4668,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteConversation", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteConversation" }, "get": { "description": "Fetch a conversation from your account's default service", @@ -3755,6 +4692,69 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3766,10 +4766,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConversation", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConversation" } }, "/v1/Conversations/{ConversationSid}/Messages": { @@ -3786,7 +4783,6 @@ "author", "date_created" ], - "pathType": "list", "dependentProperties": { "delivery_receipts": { "mapping": { @@ -3803,7 +4799,8 @@ "resource_url": "/v1/Conversations/{conversation_sid}/Messages/{message_sid}/ChannelMetadata" } }, - "parent": "/Conversations/{Sid}" + "parent": "/Conversations/{Sid}", + "pathType": "list" }, "post": { "description": "Add a new message to the conversation", @@ -3836,6 +4833,196 @@ "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", + "channel_metadata": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata" + } + } + }, + "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", + "channel_metadata": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata" + } + } + }, + "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", + "channel_metadata": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata" + } + } + }, + "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", + "channel_metadata": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata" + } + } + }, + "createWithSubject": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "body": "message body", + "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", + "channel_metadata": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3848,9 +5035,6 @@ } ], "operationId": "CreateConversationMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3903,12 +5087,55 @@ "description": "The subject of the message, can be up to 256 characters long." } } + }, + "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\"}" + } + }, + "createWithSubject": { + "value": { + "Author": "message author", + "Body": "message body", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z", + "Subject": "message subject" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -3933,6 +5160,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/conversation_message_enum_order_type" + }, + "examples": { + "readLastMessage": { + "value": "desc" + } } }, { @@ -3977,16 +5209,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3995,21 +5229,209 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListConversationMessageResponse" + }, + "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", + "channel_metadata": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata" + } + }, + { + "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", + "channel_metadata": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata" + } + }, + { + "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", + "channel_metadata": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata" + } + } + ] + } + }, + "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", + "channel_metadata": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata" + } + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4021,10 +5443,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListConversationMessage", - "x-maturity": [ - "GA" - ] + "operationId": "ListConversationMessage" } }, "/v1/Conversations/{ConversationSid}/Messages/{Sid}": { @@ -4041,7 +5460,6 @@ "author", "date_created" ], - "pathType": "instance", "dependentProperties": { "delivery_receipts": { "mapping": { @@ -4058,7 +5476,8 @@ "resource_url": "/v1/Conversations/{conversation_sid}/Messages/{message_sid}/ChannelMetadata" } }, - "parent": "/Conversations/{Sid}" + "parent": "/Conversations/{Sid}", + "pathType": "instance" }, "post": { "description": "Update an existing message in the conversation", @@ -4103,6 +5522,73 @@ "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", + "channel_metadata": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4115,9 +5601,6 @@ } ], "operationId": "UpdateConversationMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4152,12 +5635,20 @@ "description": "The subject of the message, can be up to 256 characters long." } } + }, + "examples": { + "update": { + "value": { + "Body": "Hello", + "Author": "message author", + "Attributes": "{ \"importance\": \"high\" }", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -4207,10 +5698,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteConversationMessage", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteConversationMessage" }, "get": { "description": "Fetch a message from the conversation", @@ -4246,6 +5734,73 @@ "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", + "channel_metadata": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4257,10 +5812,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConversationMessage", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConversationMessage" } }, "/v1/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts/{Sid}": { @@ -4277,9 +5829,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", @@ -4327,6 +5879,59 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4338,10 +5943,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConversationMessageReceipt", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConversationMessageReceipt" } }, "/v1/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts": { @@ -4358,9 +5960,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", @@ -4431,16 +6033,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4449,21 +6053,111 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListConversationMessageReceiptResponse" + }, + "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" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4475,10 +6169,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListConversationMessageReceipt", - "x-maturity": [ - "GA" - ] + "operationId": "ListConversationMessageReceipt" } }, "/v1/Conversations/{ConversationSid}/Participants": { @@ -4493,8 +6184,8 @@ "sid", "messaging_binding" ], - "pathType": "list", - "parent": "/Conversations/{Sid}" + "parent": "/Conversations/{Sid}", + "pathType": "list" }, "post": { "description": "Add a new participant to the conversation", @@ -4527,6 +6218,137 @@ "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4539,9 +6361,6 @@ } ], "operationId": "CreateConversationParticipant", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4587,15 +6406,59 @@ "description": "The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant." } } - } - } - } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true - } - }, - "get": { + }, + "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", "tags": [ "ConversationsV1Participant" @@ -4652,16 +6515,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4670,21 +6535,104 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListConversationParticipantResponse" + }, + "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 + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4696,10 +6644,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListConversationParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "ListConversationParticipant" } }, "/v1/Conversations/{ConversationSid}/Participants/{Sid}": { @@ -4714,8 +6659,8 @@ "sid", "messaging_binding" ], - "pathType": "instance", - "parent": "/Conversations/{Sid}" + "parent": "/Conversations/{Sid}", + "pathType": "instance" }, "post": { "description": "Update an existing participant in the conversation", @@ -4757,6 +6702,83 @@ "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4769,9 +6791,6 @@ } ], "operationId": "UpdateConversationParticipant", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4822,12 +6841,24 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -4874,10 +6905,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteConversationParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteConversationParticipant" }, "get": { "description": "Fetch a participant of the conversation", @@ -4910,6 +6938,84 @@ "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 + } + }, + "fetchByIdentity": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "alice", + "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4921,10 +7027,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConversationParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConversationParticipant" } }, "/v1/Conversations/{ConversationSid}/Webhooks": { @@ -4939,8 +7042,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", @@ -4999,16 +7102,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5017,21 +7122,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" } }, "title": "ListConversationScopedWebhookResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5043,10 +7259,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListConversationScopedWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "ListConversationScopedWebhook" }, "post": { "description": "Create a new webhook scoped to the conversation", @@ -5070,6 +7283,63 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5082,9 +7352,6 @@ } ], "operationId": "CreateConversationScopedWebhook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5135,6 +7402,20 @@ "required": [ "Target" ] + }, + "examples": { + "create": { + "value": { + "Target": "webhook", + "Configuration.Url": "https://example.com", + "Configuration.Method": "get", + "Configuration.Filters": [ + "onMessageSent", + "onConversationDestroyed" + ], + "Configuration.ReplayAfter": 7 + } + } } } } @@ -5153,8 +7434,8 @@ "sid", "target" ], - "pathType": "instance", - "parent": "/Conversations/{Sid}" + "parent": "/Conversations/{Sid}", + "pathType": "instance" }, "get": { "description": "Fetch the configuration of a conversation-scoped webhook", @@ -5190,6 +7471,58 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5201,10 +7534,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConversationScopedWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConversationScopedWebhook" }, "post": { "description": "Update an existing conversation-scoped webhook", @@ -5240,6 +7570,63 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5252,9 +7639,6 @@ } ], "operationId": "UpdateConversationScopedWebhook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5293,12 +7677,21 @@ "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" + ] + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -5339,10 +7732,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteConversationScopedWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteConversationScopedWebhook" } }, "/v1/Credentials": { @@ -5371,6 +7761,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5383,9 +7823,6 @@ } ], "operationId": "CreateCredential", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5426,6 +7863,13 @@ "required": [ "Type" ] + }, + "examples": { + "create": { + "value": { + "Type": "apn" + } + } } } } @@ -5479,16 +7923,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5497,21 +7943,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" } }, "title": "ListCredentialResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5523,10 +8044,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCredential", - "x-maturity": [ - "GA" - ] + "operationId": "ListCredential" } }, "/v1/Credentials/{Sid}": { @@ -5569,6 +8087,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5581,9 +8149,6 @@ } ], "operationId": "UpdateCredential", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5621,12 +8186,16 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -5658,10 +8227,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCredential", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCredential" }, "get": { "description": "Fetch a push notification credential from your account", @@ -5688,21 +8254,68 @@ "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": [] - } + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } ], - "operationId": "FetchCredential", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCredential" } }, "/v1/ParticipantConversations": { @@ -5732,6 +8345,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" + } } }, { @@ -5740,6 +8361,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" + } } }, { @@ -5784,16 +8410,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5802,21 +8430,156 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListParticipantConversationResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5828,10 +8591,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListParticipantConversation", - "x-maturity": [ - "GA" - ] + "operationId": "ListParticipantConversation" } }, "/v1/Roles": { @@ -5860,6 +8620,62 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5872,9 +8688,6 @@ } ], "operationId": "CreateRole", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5904,6 +8717,15 @@ "Type", "Permission" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "Conversation Role", + "Type": "conversation", + "Permission": "sendMessage" + } + } } } } @@ -5957,16 +8779,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5975,21 +8799,102 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListRoleResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6001,10 +8906,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRole", - "x-maturity": [ - "GA" - ] + "operationId": "ListRole" } }, "/v1/Roles/{Sid}": { @@ -6047,6 +8949,62 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6059,9 +9017,6 @@ } ], "operationId": "UpdateRole", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6080,6 +9035,13 @@ "required": [ "Permission" ] + }, + "examples": { + "update": { + "value": { + "Permission": "sendMessage" + } + } } } } @@ -6114,10 +9076,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRole", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRole" }, "get": { "description": "Fetch a user role from your account's default service", @@ -6144,6 +9103,62 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6155,10 +9170,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRole", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRole" } }, "/v1/Services": { @@ -6173,7 +9185,6 @@ "sid", "friendly_name" ], - "pathType": "list", "dependentProperties": { "conversations": { "mapping": { @@ -6211,7 +9222,8 @@ }, "resource_url": "/v1/Services/{chat_service_sid}/ParticipantConversations" } - } + }, + "pathType": "list" }, "post": { "description": "Create a new conversation service on your account", @@ -6224,6 +9236,62 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6236,9 +9304,6 @@ } ], "operationId": "CreateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6254,6 +9319,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } @@ -6307,16 +9379,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -6325,21 +9399,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" } }, "title": "ListServiceResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6351,10 +9492,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListService", - "x-maturity": [ - "GA" - ] + "operationId": "ListService" } }, "/v1/Services/{Sid}": { @@ -6369,7 +9507,6 @@ "sid", "friendly_name" ], - "pathType": "instance", "dependentProperties": { "conversations": { "mapping": { @@ -6407,7 +9544,8 @@ }, "resource_url": "/v1/Services/{chat_service_sid}/ParticipantConversations" } - } + }, + "pathType": "instance" }, "delete": { "description": "Remove a conversation service with all its nested resources from your account", @@ -6438,10 +9576,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteService", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteService" }, "get": { "description": "Fetch a conversation service from your account", @@ -6468,6 +9603,62 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6479,10 +9670,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchService", - "x-maturity": [ - "GA" - ] + "operationId": "FetchService" } }, "/v1/Services/{ChatServiceSid}/Bindings/{Sid}": { @@ -6498,8 +9686,8 @@ "endpoint", "identity" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "delete": { "description": "Remove a push notification binding from the conversation service", @@ -6542,10 +9730,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteServiceBinding", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteServiceBinding" }, "get": { "description": "Fetch a push notification binding from the conversation service", @@ -6584,6 +9769,63 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6595,10 +9837,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchServiceBinding", - "x-maturity": [ - "GA" - ] + "operationId": "FetchServiceBinding" } }, "/v1/Services/{ChatServiceSid}/Bindings": { @@ -6614,8 +9853,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", @@ -6706,16 +9945,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -6724,36 +9965,115 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListServiceBindingResponse" + }, + "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": [ - { + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { "accountSid_authToken": [] } ], - "operationId": "ListServiceBinding", - "x-maturity": [ - "GA" - ] + "operationId": "ListServiceBinding" } }, "/v1/Services/{ChatServiceSid}/Configuration": { @@ -6767,8 +10087,8 @@ "defaultOutputProperties": [ "chat_service_sid" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "Fetch the configuration of a conversation service", @@ -6795,6 +10115,58 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6806,10 +10178,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchServiceConfiguration", - "x-maturity": [ - "GA" - ] + "operationId": "FetchServiceConfiguration" }, "post": { "description": "Update configuration settings of a conversation service", @@ -6836,6 +10205,58 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6848,9 +10269,6 @@ } ], "operationId": "UpdateServiceConfiguration", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6884,12 +10302,19 @@ "description": "Whether the [Reachability Indicator](https://www.twilio.com/docs/conversations/reachability) is enabled for this Conversations Service. The default is `false`." } } + }, + "examples": { + "update": { + "value": { + "DefaultConversationCreatorRoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DefaultConversationRoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "DefaultChatServiceRoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ReachabilityEnabled": false + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -6907,7 +10332,6 @@ "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { "participants": { "mapping": { @@ -6931,7 +10355,8 @@ "resource_url": "/v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Webhooks" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "Create a new conversation in your service", @@ -6967,6 +10392,91 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6979,9 +10489,6 @@ } ], "operationId": "CreateServiceConversation", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -7040,12 +10547,33 @@ "description": "The default name that will be used when sending outbound emails in this conversation." } } + }, + "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -7133,16 +10661,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -7151,21 +10681,95 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListServiceConversationResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -7177,10 +10781,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListServiceConversation", - "x-maturity": [ - "GA" - ] + "operationId": "ListServiceConversation" } }, "/v1/Services/{ChatServiceSid}/Conversations/{Sid}": { @@ -7197,7 +10798,6 @@ "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { "participants": { "mapping": { @@ -7221,7 +10821,8 @@ "resource_url": "/v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Webhooks" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "post": { "description": "Update an existing conversation in your service", @@ -7266,6 +10867,69 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -7278,9 +10942,6 @@ } ], "operationId": "UpdateServiceConversation", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -7339,12 +11000,24 @@ "description": "The default name that will be used when sending outbound emails in this conversation." } } + }, + "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -7394,10 +11067,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteServiceConversation", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteServiceConversation" }, "get": { "description": "Fetch a conversation from your service", @@ -7433,6 +11103,69 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -7444,10 +11177,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchServiceConversation", - "x-maturity": [ - "GA" - ] + "operationId": "FetchServiceConversation" } }, "/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages": { @@ -7464,7 +11194,6 @@ "author", "date_created" ], - "pathType": "list", "dependentProperties": { "delivery_receipts": { "mapping": { @@ -7483,7 +11212,8 @@ "resource_url": "/v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Messages/{message_sid}/ChannelMetadata" } }, - "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", @@ -7528,6 +11258,201 @@ "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", + "channel_metadata": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata" + } + } + }, + "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", + "channel_metadata": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata" + } + } + }, + "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", + "channel_metadata": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata" + } + } + }, + "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", + "channel_metadata": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata" + } + } + }, + "createWithSubject": { + "value": { + "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "body": "message body", + "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", + "channel_metadata": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -7540,9 +11465,6 @@ } ], "operationId": "CreateServiceConversationMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -7595,12 +11517,55 @@ "description": "The subject of the message, can be up to 256 characters long." } } + }, + "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\"}" + } + }, + "createWithSubject": { + "value": { + "Author": "message author", + "Body": "message body", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z", + "Subject": "message subject" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -7637,6 +11602,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/service_conversation_message_enum_order_type" + }, + "examples": { + "readLastMessage": { + "value": "desc" + } } }, { @@ -7681,16 +11651,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -7699,21 +11671,213 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListServiceConversationMessageResponse" + }, + "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", + "channel_metadata": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata" + } + }, + { + "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", + "channel_metadata": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata" + } + }, + { + "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", + "channel_metadata": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata" + } + } + ] + } + }, + "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", + "channel_metadata": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata" + } + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -7725,10 +11889,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListServiceConversationMessage", - "x-maturity": [ - "GA" - ] + "operationId": "ListServiceConversationMessage" } }, "/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{Sid}": { @@ -7745,7 +11906,6 @@ "author", "date_created" ], - "pathType": "instance", "dependentProperties": { "delivery_receipts": { "mapping": { @@ -7764,7 +11924,8 @@ "resource_url": "/v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Messages/{message_sid}/ChannelMetadata" } }, - "parent": "/Services/{ChatServiceSid}/Conversations/{Sid}" + "parent": "/Services/{ChatServiceSid}/Conversations/{Sid}", + "pathType": "instance" }, "post": { "description": "Update an existing message in the conversation", @@ -7821,6 +11982,74 @@ "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", + "channel_metadata": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -7833,9 +12062,6 @@ } ], "operationId": "UpdateServiceConversationMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -7870,12 +12096,20 @@ "description": "The subject of the message, can be up to 256 characters long." } } + }, + "examples": { + "update": { + "value": { + "Body": "Hello", + "Author": "message author", + "Attributes": "{ \"importance\": \"high\" }", + "DateCreated": "2015-12-16T22:18:37Z", + "DateUpdated": "2015-12-16T22:18:38Z" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -7937,10 +12171,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteServiceConversationMessage", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteServiceConversationMessage" }, "get": { "description": "Fetch a message from the conversation", @@ -7988,21 +12219,86 @@ "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", + "channel_metadata": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata" + } + } + } } } }, - "description": "OK" - } - }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, "security": [ { "accountSid_authToken": [] } ], - "operationId": "FetchServiceConversationMessage", - "x-maturity": [ - "GA" - ] + "operationId": "FetchServiceConversationMessage" } }, "/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts/{Sid}": { @@ -8019,9 +12315,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", @@ -8081,6 +12377,60 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -8092,10 +12442,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchServiceConversationMessageReceipt", - "x-maturity": [ - "GA" - ] + "operationId": "FetchServiceConversationMessageReceipt" } }, "/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts": { @@ -8112,9 +12459,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", @@ -8197,16 +12544,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -8215,21 +12564,114 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListServiceConversationMessageReceiptResponse" + }, + "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" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -8241,10 +12683,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListServiceConversationMessageReceipt", - "x-maturity": [ - "GA" - ] + "operationId": "ListServiceConversationMessageReceipt" } }, "/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants": { @@ -8259,8 +12698,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", @@ -8305,6 +12744,142 @@ "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -8317,9 +12892,6 @@ } ], "operationId": "CreateServiceConversationParticipant", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -8365,12 +12937,56 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -8442,16 +13058,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -8460,21 +13078,106 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListServiceConversationParticipantResponse" + }, + "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 + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -8486,10 +13189,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListServiceConversationParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "ListServiceConversationParticipant" } }, "/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants/{Sid}": { @@ -8504,8 +13204,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", @@ -8559,6 +13259,85 @@ "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -8571,9 +13350,6 @@ } ], "operationId": "UpdateServiceConversationParticipant", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -8624,12 +13400,24 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -8688,10 +13476,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteServiceConversationParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteServiceConversationParticipant" }, "get": { "description": "Fetch a participant of the conversation", @@ -8736,6 +13521,86 @@ "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 + } + }, + "fetchByIdentity": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "alice", + "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -8747,10 +13612,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchServiceConversationParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "FetchServiceConversationParticipant" } }, "/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks": { @@ -8765,8 +13627,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", @@ -8802,6 +13664,64 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -8814,9 +13734,6 @@ } ], "operationId": "CreateServiceConversationScopedWebhook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -8867,6 +13784,20 @@ "required": [ "Target" ] + }, + "examples": { + "create": { + "value": { + "Target": "webhook", + "Configuration.Url": "https://example.com", + "Configuration.Method": "get", + "Configuration.Filters": [ + "onMessageSent", + "onConversationDestroyed" + ], + "Configuration.ReplayAfter": 7 + } + } } } } @@ -8941,16 +13872,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -8959,21 +13892,135 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListServiceConversationScopedWebhookResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -8985,10 +14032,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListServiceConversationScopedWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "ListServiceConversationScopedWebhook" } }, "/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks/{Sid}": { @@ -9003,8 +14047,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", @@ -9052,6 +14096,64 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -9064,9 +14166,6 @@ } ], "operationId": "UpdateServiceConversationScopedWebhook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -9105,12 +14204,21 @@ "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" + ] + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -9163,10 +14271,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteServiceConversationScopedWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteServiceConversationScopedWebhook" }, "get": { "description": "Fetch the configuration of a conversation-scoped webhook", @@ -9214,21 +14319,71 @@ "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" - ] + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchServiceConversationScopedWebhook" } }, "/v1/Services/{ChatServiceSid}/Configuration/Notifications": { @@ -9242,8 +14397,8 @@ "defaultOutputProperties": [ "chat_service_sid" ], - "pathType": "instance", - "parent": "/Services/{ChatServiceSid}/Configuration" + "parent": "/Services/{ChatServiceSid}/Configuration", + "pathType": "instance" }, "post": { "description": "Update push notification service settings", @@ -9270,6 +14425,72 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -9282,9 +14503,6 @@ } ], "operationId": "UpdateServiceNotification", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -9345,12 +14563,28 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -9378,6 +14612,72 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -9389,10 +14689,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchServiceNotification", - "x-maturity": [ - "GA" - ] + "operationId": "FetchServiceNotification" } }, "/v1/Services/{ChatServiceSid}/ParticipantConversations": { @@ -9408,8 +14705,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.", @@ -9435,6 +14732,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" + } } }, { @@ -9443,6 +14748,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" + } } }, { @@ -9487,16 +14797,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -9505,21 +14817,156 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListServiceParticipantConversationResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -9531,10 +14978,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListServiceParticipantConversation", - "x-maturity": [ - "GA" - ] + "operationId": "ListServiceParticipantConversation" } }, "/v1/Services/{ChatServiceSid}/Roles": { @@ -9550,8 +14994,8 @@ "friendly_name", "type" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "Create a new user role in your service", @@ -9578,6 +15022,62 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -9590,9 +15090,6 @@ } ], "operationId": "CreateServiceRole", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -9622,6 +15119,15 @@ "Type", "Permission" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "Conversation Role", + "Type": "conversation", + "Permission": "sendMessage" + } + } } } } @@ -9687,16 +15193,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -9705,21 +15213,102 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListServiceRoleResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -9731,10 +15320,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListServiceRole", - "x-maturity": [ - "GA" - ] + "operationId": "ListServiceRole" } }, "/v1/Services/{ChatServiceSid}/Roles/{Sid}": { @@ -9750,8 +15336,8 @@ "friendly_name", "type" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "post": { "description": "Update an existing user role in your service", @@ -9790,6 +15376,62 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -9802,9 +15444,6 @@ } ], "operationId": "UpdateServiceRole", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -9823,6 +15462,13 @@ "required": [ "Permission" ] + }, + "examples": { + "update": { + "value": { + "Permission": "sendMessage" + } + } } } } @@ -9869,10 +15515,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteServiceRole", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteServiceRole" }, "get": { "description": "Fetch a user role from your service", @@ -9911,6 +15554,62 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -9922,10 +15621,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchServiceRole", - "x-maturity": [ - "GA" - ] + "operationId": "FetchServiceRole" } }, "/v1/Services/{ChatServiceSid}/Users": { @@ -9940,7 +15636,6 @@ "sid", "identity" ], - "pathType": "list", "dependentProperties": { "user_conversations": { "mapping": { @@ -9950,7 +15645,8 @@ "resource_url": "/v1/Services/{chat_service_sid}/Users/{user_sid}/Conversations" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "Add a new conversation user to your service", @@ -9986,6 +15682,63 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -9998,9 +15751,6 @@ } ], "operationId": "CreateServiceUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -10031,6 +15781,16 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "admin", + "FriendlyName": "name", + "Attributes": "{ \"duty\": \"tech\" }", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -10096,16 +15856,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -10114,21 +15876,106 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListServiceUserResponse" + }, + "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" + } + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -10140,10 +15987,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListServiceUser", - "x-maturity": [ - "GA" - ] + "operationId": "ListServiceUser" } }, "/v1/Services/{ChatServiceSid}/Users/{Sid}": { @@ -10158,7 +16002,6 @@ "sid", "identity" ], - "pathType": "instance", "dependentProperties": { "user_conversations": { "mapping": { @@ -10168,7 +16011,8 @@ "resource_url": "/v1/Services/{chat_service_sid}/Users/{user_sid}/Conversations" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "post": { "description": "Update an existing conversation user in your service", @@ -10213,6 +16057,63 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -10225,9 +16126,6 @@ } ], "operationId": "UpdateServiceUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -10251,12 +16149,18 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -10306,10 +16210,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteServiceUser", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteServiceUser" }, "get": { "description": "Fetch a conversation user from your service", @@ -10345,7 +16246,64 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -10356,10 +16314,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchServiceUser", - "x-maturity": [ - "GA" - ] + "operationId": "FetchServiceUser" } }, "/v1/Services/{ChatServiceSid}/Users/{UserSid}/Conversations/{ConversationSid}": { @@ -10377,9 +16332,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.", @@ -10424,6 +16379,72 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -10436,9 +16457,6 @@ } ], "operationId": "UpdateServiceUserConversation", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -10462,12 +16480,18 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -10517,10 +16541,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteServiceUserConversation", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteServiceUserConversation" }, "get": { "description": "Fetch a specific User Conversation.", @@ -10565,6 +16586,72 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -10576,10 +16663,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchServiceUserConversation", - "x-maturity": [ - "GA" - ] + "operationId": "FetchServiceUserConversation" } }, "/v1/Services/{ChatServiceSid}/Users/{UserSid}/Conversations": { @@ -10597,9 +16681,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.", @@ -10670,16 +16754,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -10688,21 +16774,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" } }, "title": "ListServiceUserConversationResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -10714,10 +16891,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListServiceUserConversation", - "x-maturity": [ - "GA" - ] + "operationId": "ListServiceUserConversation" } }, "/v1/Services/{ChatServiceSid}/Configuration/Webhooks": { @@ -10731,8 +16905,8 @@ "defaultOutputProperties": [ "chat_service_sid" ], - "pathType": "instance", - "parent": "/Services/{ChatServiceSid}/Configuration" + "parent": "/Services/{ChatServiceSid}/Configuration", + "pathType": "instance" }, "post": { "description": "Update a specific Webhook.", @@ -10759,6 +16933,58 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -10771,9 +16997,6 @@ } ], "operationId": "UpdateServiceWebhookConfiguration", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -10803,12 +17026,22 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -10836,6 +17069,69 @@ "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -10847,10 +17143,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchServiceWebhookConfiguration", - "x-maturity": [ - "GA" - ] + "operationId": "FetchServiceWebhookConfiguration" } }, "/v1/Users": { @@ -10865,7 +17158,6 @@ "sid", "identity" ], - "pathType": "list", "dependentProperties": { "user_conversations": { "mapping": { @@ -10873,7 +17165,8 @@ }, "resource_url": "/v1/Users/{user_sid}/Conversations" } - } + }, + "pathType": "list" }, "post": { "description": "Add a new conversation user to your account's default service", @@ -10897,6 +17190,63 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -10909,9 +17259,6 @@ } ], "operationId": "CreateUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -10942,6 +17289,16 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "admin", + "FriendlyName": "name", + "Attributes": "{ \"duty\": \"tech\" }", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -10995,16 +17352,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -11013,21 +17372,106 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListUserResponse" + }, + "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" + } + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -11039,10 +17483,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUser", - "x-maturity": [ - "GA" - ] + "operationId": "ListUser" } }, "/v1/Users/{Sid}": { @@ -11057,7 +17498,6 @@ "sid", "identity" ], - "pathType": "instance", "dependentProperties": { "user_conversations": { "mapping": { @@ -11065,7 +17505,8 @@ }, "resource_url": "/v1/Users/{user_sid}/Conversations" } - } + }, + "pathType": "instance" }, "post": { "description": "Update an existing conversation user in your account's default service", @@ -11098,6 +17539,63 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -11110,9 +17608,6 @@ } ], "operationId": "UpdateUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -11136,12 +17631,18 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -11179,10 +17680,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUser", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteUser" }, "get": { "description": "Fetch a conversation user from your account's default service", @@ -11206,6 +17704,63 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -11217,10 +17772,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUser", - "x-maturity": [ - "GA" - ] + "operationId": "FetchUser" } }, "/v1/Users/{UserSid}/Conversations/{ConversationSid}": { @@ -11238,9 +17790,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.", @@ -11273,6 +17825,72 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -11285,9 +17903,6 @@ } ], "operationId": "UpdateUserConversation", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -11311,12 +17926,18 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -11354,10 +17975,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUserConversation", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteUserConversation" }, "get": { "description": "Fetch a specific User Conversation.", @@ -11390,6 +18008,72 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -11401,10 +18085,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUserConversation", - "x-maturity": [ - "GA" - ] + "operationId": "FetchUserConversation" } }, "/v1/Users/{UserSid}/Conversations": { @@ -11422,9 +18103,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.", @@ -11483,16 +18164,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -11501,21 +18184,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" } }, "title": "ListUserConversationResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -11527,10 +18301,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUserConversation", - "x-maturity": [ - "GA" - ] + "operationId": "ListUserConversation" } } }, @@ -11546,6 +18317,9 @@ { "name": "ConversationsV1Binding" }, + { + "name": "ConversationsV1ChannelMetadata" + }, { "name": "ConversationsV1Configuration" }, @@ -11576,6 +18350,15 @@ { "name": "ConversationsV1Service" }, + { + "name": "ConversationsV1StatsConversationsRatelimitingerrors" + }, + { + "name": "ConversationsV1StatsTwilsockConcurrentconnections" + }, + { + "name": "ConversationsV1StatsTwilsockRatelimitingerrors" + }, { "name": "ConversationsV1User" }, @@ -11586,10 +18369,9 @@ "name": "ConversationsV1Webhook" } ], - "x-maturity": [ + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_events_v1.json b/src/services/twilio-api/twilio_events_v1.json index e4a1e2e2..899fec76 100644 --- a/src/services/twilio-api/twilio_events_v1.json +++ b/src/services/twilio-api/twilio_events_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "events.v1.event_type": { "type": "object", @@ -31,6 +37,16 @@ "nullable": true, "description": "A human readable description for this Event Type." }, + "status": { + "type": "string", + "nullable": true, + "description": "A string that describes how this Event Type can be used. For example: `available`, `deprecated`, `restricted`, `discontinued`. When the status is `available`, the Event Type can be used normally." + }, + "documentation_url": { + "type": "string", + "nullable": true, + "description": "The URL to the documentation or to the most relevant Twilio Changelog entry of this Event Type." + }, "url": { "type": "string", "format": "uri", @@ -299,12 +315,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -320,7 +330,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -337,8 +347,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.", @@ -352,6 +362,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" + } } }, { @@ -396,16 +411,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -414,21 +431,200 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListEventTypeResponse" + }, + "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, + "status": "available", + "documentation_url": null, + "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, + "status": "deprecated", + "documentation_url": "https://www.twilio.com/docs/voice/voice-insights/event-streams", + "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" + } + } + }, + "readResultsRollbackStatusAndDocsFields": { + "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, + "status": "available", + "documentation_url": null, + "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, + "status": "available", + "documentation_url": null, + "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, + "status": "available", + "documentation_url": null, + "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, + "status": "deprecated", + "documentation_url": "https://www.twilio.com/docs/voice/voice-insights/event-streams", + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -440,10 +636,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListEventType", - "x-maturity": [ - "GA" - ] + "operationId": "ListEventType" } }, "/v1/Types/{Type}": { @@ -459,8 +652,8 @@ "schema_id", "description" ], - "pathType": "instance", - "mountName": "event_types" + "mountName": "event_types", + "pathType": "instance" }, "get": { "description": "Fetch a specific Event Type.", @@ -484,6 +677,92 @@ "application/json": { "schema": { "$ref": "#/components/schemas/events.v1.event_type" + }, + "examples": { + "fetchNoDocs": { + "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", + "status": "available", + "documentation_url": null, + "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" + } + } + }, + "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, + "status": "available", + "documentation_url": "https://www.twilio.com/docs/voice/voice-insights/event-streams", + "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" + } + } + }, + "fetchRollbackStatusAndDocsFields": { + "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, + "status": "available", + "documentation_url": null, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -495,10 +774,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEventType", - "x-maturity": [ - "GA" - ] + "operationId": "FetchEventType" } }, "/v1/Schemas/{Id}": { @@ -512,7 +788,6 @@ "defaultOutputProperties": [ "id" ], - "pathType": "instance", "dependentProperties": { "versions": { "mapping": { @@ -520,7 +795,8 @@ }, "resource_url": "/v1/Schemas/{id}/Versions" } - } + }, + "pathType": "instance" }, "get": { "description": "Fetch a specific schema with its nested versions.", @@ -544,6 +820,55 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -555,10 +880,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSchema", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSchema" } }, "/v1/Schemas": { @@ -572,7 +894,6 @@ "defaultOutputProperties": [ "id" ], - "pathType": "list", "dependentProperties": { "versions": { "mapping": { @@ -580,7 +901,8 @@ }, "resource_url": "/v1/Schemas/{id}/Versions" } - } + }, + "pathType": "list" } }, "/v1/Schemas/{Id}/Versions": { @@ -596,9 +918,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.", @@ -657,16 +979,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -675,21 +999,102 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListSchemaVersionResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -701,10 +1106,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSchemaVersion", - "x-maturity": [ - "GA" - ] + "operationId": "ListSchemaVersion" } }, "/v1/Schemas/{Id}/Versions/{SchemaVersion}": { @@ -720,9 +1122,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.", @@ -755,6 +1157,54 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -766,10 +1216,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSchemaVersion", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSchemaVersion" } }, "/v1/Sinks/{Sid}": { @@ -789,7 +1236,6 @@ "sink_type", "status" ], - "pathType": "instance", "dependentProperties": { "sink_test": { "mapping": { @@ -803,7 +1249,8 @@ }, "resource_url": "/v1/Sinks/{sid}/Validate" } - } + }, + "pathType": "instance" }, "get": { "description": "Fetch a specific Sink.", @@ -830,6 +1277,64 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -841,10 +1346,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSink", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSink" }, "delete": { "description": "Delete a specific Sink.", @@ -875,10 +1377,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSink", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSink" }, "post": { "description": "Update a specific Sink", @@ -905,6 +1404,64 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -917,9 +1474,6 @@ } ], "operationId": "UpdateSink", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -935,6 +1489,13 @@ "required": [ "Description" ] + }, + "examples": { + "update": { + "value": { + "Description": "My Kinesis Sink" + } + } } } } @@ -958,7 +1519,6 @@ "sink_type", "status" ], - "pathType": "list", "dependentProperties": { "sink_test": { "mapping": { @@ -972,7 +1532,8 @@ }, "resource_url": "/v1/Sinks/{sid}/Validate" } - } + }, + "pathType": "list" }, "post": { "description": "Create a new Sink", @@ -985,6 +1546,82 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -997,9 +1634,6 @@ } ], "operationId": "CreateSink", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1025,6 +1659,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\"}" + } + } } } } @@ -1042,6 +1692,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 + } } }, { @@ -1050,6 +1705,11 @@ "description": "A String query parameter filtering the results by status `initialized`, `validating`, `active` or `failed`.", "schema": { "type": "string" + }, + "examples": { + "readResultsStatus": { + "value": "active" + } } }, { @@ -1094,16 +1754,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1112,21 +1774,242 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListSinkResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1138,10 +2021,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSink", - "x-maturity": [ - "GA" - ] + "operationId": "ListSink" } }, "/v1/Sinks/{Sid}/Test": { @@ -1155,9 +2035,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.", @@ -1184,6 +2064,49 @@ "application/json": { "schema": { "$ref": "#/components/schemas/events.v1.sink.sink_test" + }, + "examples": { + "create": { + "value": { + "result": "submitted" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1195,10 +2118,7 @@ "accountSid_authToken": [] } ], - "operationId": "CreateSinkTest", - "x-maturity": [ - "GA" - ] + "operationId": "CreateSinkTest" } }, "/v1/Sinks/{Sid}/Validate": { @@ -1212,9 +2132,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.", @@ -1241,6 +2161,49 @@ "application/json": { "schema": { "$ref": "#/components/schemas/events.v1.sink.sink_validate" + }, + "examples": { + "create": { + "value": { + "result": "valid" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1253,9 +2216,6 @@ } ], "operationId": "CreateSinkValidate", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1271,6 +2231,13 @@ "required": [ "TestId" ] + }, + "examples": { + "create": { + "value": { + "TestId": "TestID" + } + } } } } @@ -1291,8 +2258,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.", @@ -1354,16 +2321,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1372,21 +2341,100 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListSubscribedEventResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1398,10 +2446,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSubscribedEvent", - "x-maturity": [ - "GA" - ] + "operationId": "ListSubscribedEvent" }, "post": { "description": "Add an event type to a Subscription.", @@ -1428,6 +2473,53 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1440,9 +2532,6 @@ } ], "operationId": "CreateSubscribedEvent", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1462,6 +2551,14 @@ "required": [ "Type" ] + }, + "examples": { + "create": { + "value": { + "Type": "com.twilio.messaging.message.delivered", + "SchemaVersion": 2 + } + } } } } @@ -1482,8 +2579,8 @@ "account_sid", "subscription_sid" ], - "pathType": "instance", - "parent": "/Subscriptions/{Sid}" + "parent": "/Subscriptions/{Sid}", + "pathType": "instance" }, "get": { "description": "Read an Event for a Subscription.", @@ -1519,6 +2616,53 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1530,10 +2674,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSubscribedEvent", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSubscribedEvent" }, "post": { "description": "Update an Event for a Subscription.", @@ -1569,6 +2710,53 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1581,9 +2769,6 @@ } ], "operationId": "UpdateSubscribedEvent", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1596,12 +2781,16 @@ "description": "The schema version that the Subscription should use." } } + }, + "examples": { + "update": { + "value": { + "SchemaVersion": 2 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -1642,10 +2831,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSubscribedEvent", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSubscribedEvent" } }, "/v1/Subscriptions": { @@ -1663,7 +2849,6 @@ "date_created", "date_updated" ], - "pathType": "list", "dependentProperties": { "subscribed_events": { "mapping": { @@ -1671,7 +2856,8 @@ }, "resource_url": "/v1/Subscriptions/{subscription_sid}/SubscribedEvents" } - } + }, + "pathType": "list" }, "get": { "description": "Retrieve a paginated list of Subscriptions belonging to the account used to make the request.", @@ -1688,6 +2874,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^DG[0-9a-fA-F]{32}$" + }, + "examples": { + "readResultsFilteredBySinkSid": { + "value": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -1732,16 +2923,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1750,21 +2943,149 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListSubscriptionResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1776,22 +3097,72 @@ "accountSid_authToken": [] } ], - "operationId": "ListSubscription", - "x-maturity": [ - "GA" - ] + "operationId": "ListSubscription" }, "post": { "description": "Create a new Subscription.", "tags": [ "EventsV1Subscription" ], + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1804,9 +3175,6 @@ } ], "operationId": "CreateSubscription", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1836,6 +3204,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}" + ] + } + } } } } @@ -1857,7 +3237,6 @@ "date_created", "date_updated" ], - "pathType": "instance", "dependentProperties": { "subscribed_events": { "mapping": { @@ -1865,7 +3244,8 @@ }, "resource_url": "/v1/Subscriptions/{subscription_sid}/SubscribedEvents" } - } + }, + "pathType": "instance" }, "get": { "description": "Fetch a specific Subscription.", @@ -1892,6 +3272,58 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1903,10 +3335,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSubscription", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSubscription" }, "post": { "description": "Update a Subscription.", @@ -1933,6 +3362,58 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1945,9 +3426,6 @@ } ], "operationId": "UpdateSubscription", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1967,12 +3445,17 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -2004,10 +3487,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSubscription", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSubscription" } } }, @@ -2042,10 +3522,9 @@ "name": "EventsV1Subscription" } ], - "x-maturity": [ + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_flex_v1.json b/src/services/twilio-api/twilio_flex_v1.json index bc24f962..50ff75a9 100644 --- a/src/services/twilio-api/twilio_flex_v1.json +++ b/src/services/twilio-api/twilio_flex_v1.json @@ -1,6 +1,18 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { + "ai_insights_enum_tag_group": { + "type": "string", + "enum": [ + "topics" + ] + }, "flex.v1.channel": { "type": "object", "properties": { @@ -718,6 +730,72 @@ } } }, + "insights_conversational_ai_enum_granularity": { + "type": "string", + "enum": [ + "days", + "weeks", + "months", + "quarters", + "years" + ] + }, + "insights_conversational_ai_enum_name": { + "type": "string", + "enum": [ + "predictive_scores", + "channel_metrics", + "agent_metrics", + "queue_metrics", + "agents_csat_summary", + "topic_metrics", + "conversation_metrics", + "trend_metrics" + ] + }, + "insights_conversational_ai_enum_type": { + "type": "string", + "enum": [ + "metrics", + "summary", + "trend" + ] + }, + "insights_conversational_ai_enum_sort_direction": { + "type": "string", + "enum": [ + "asc", + "desc" + ] + }, + "insights_conversational_ai_enum_sort_by": { + "type": "string", + "enum": [ + "record_count", + "scored_count", + "total", + "mean", + "scored_mean", + "score" + ] + }, + "insights_conversational_ai_enum_score_id": { + "type": "string", + "enum": [ + "~predicted-csat", + "~agent-experience", + "~customer-effort", + "~multitouch-risk" + ] + }, + "insights_conversational_ai_enum_tier": { + "type": "string", + "enum": [ + "Low", + "High", + "Neutral" + ] + }, "flex.v1.insights_conversations": { "type": "object", "properties": { @@ -1219,6 +1297,26 @@ "inactive" ] }, + "interaction_channel_app_enum_type": { + "type": "string", + "enum": [ + "transcription", + "studio" + ] + }, + "interaction_channel_app_enum_status": { + "type": "string", + "enum": [ + "adding", + "active", + "pausing", + "paused", + "resuming", + "removing", + "removed", + "errored" + ] + }, "flex.v1.interaction.interaction_channel.interaction_channel_invite": { "type": "object", "properties": { @@ -1832,6 +1930,22 @@ "failed" ] }, + "transfer_enum_transfer_status": { + "type": "string", + "enum": [ + "active", + "failed", + "completed" + ] + }, + "transfer_enum_transfer_type": { + "type": "string", + "enum": [ + "warm", + "cold", + "external" + ] + }, "flex.v1.web_channel": { "type": "object", "properties": { @@ -1885,12 +1999,6 @@ "inactive" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -1906,7 +2014,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -1924,8 +2032,8 @@ "user_sid", "task_sid" ], - "pathType": "list", - "mountName": "channel" + "mountName": "channel", + "pathType": "list" }, "get": { "description": "", @@ -1975,16 +2083,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1993,21 +2103,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" } }, "title": "ListChannelResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2019,10 +2204,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListChannel" }, "post": { "description": "", @@ -2035,6 +2217,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2047,9 +2279,6 @@ } ], "operationId": "CreateChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2110,6 +2339,22 @@ "ChatUserFriendlyName", "ChatFriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FlexFlowSid": "FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Target": "def", + "Identity": "abc", + "ChatUserFriendlyName": "friendly2", + "ChatFriendlyName": "friendly1", + "ChatUniqueName": "unique", + "PreEngagementData": "{}", + "TaskSid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "TaskAttributes": "{}", + "LongLived": true + } + } } } } @@ -2130,8 +2375,8 @@ "user_sid", "task_sid" ], - "pathType": "instance", - "mountName": "channel" + "mountName": "channel", + "pathType": "instance" }, "get": { "description": "", @@ -2158,6 +2403,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2169,10 +2464,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchChannel", - "x-maturity": [ - "GA" - ] + "operationId": "FetchChannel" }, "delete": { "description": "", @@ -2203,10 +2495,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteChannel", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteChannel" } }, "/v1/Configuration": { @@ -2246,6 +2535,568 @@ "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", + "flex_instance_sid": "GOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "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, + "console_errors_included": false + }, + "flex_ui_status_report": { + "enabled": false + }, + "agent_conv_end_methods": { + "enabled": [ + "Leave" + ], + "dateUpdated": "2023-08-16T12:22:06.787Z" + }, + "citrix_voice_vdi": { + "enabled": false + }, + "offline_config": { + "presence": true, + "presence_ttl": 30 + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchConfiguration" + }, + "post": { + "description": "", + "tags": [ + "FlexV1Configuration" + ], + "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", + "flex_instance_sid": "GOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "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, + "console_errors_included": false + }, + "flex_ui_status_report": { + "enabled": false + }, + "agent_conv_end_methods": { + "enabled": [ + "Leave" + ], + "dateUpdated": "2023-08-16T12:22:06.787Z" + }, + "citrix_voice_vdi": { + "enabled": false + }, + "offline_config": { + "presence": true, + "presence_ttl": 30 + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2257,10 +3108,18 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConfiguration", - "x-maturity": [ - "GA" - ] + "operationId": "UpdateConfiguration", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "UpdateConfigurationRequest", + "properties": {} + } + } + } + } } }, "/v1/PluginService/Configurations/{ConfigurationSid}/Plugins": { @@ -2269,7 +3128,7 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "plugin_sid", @@ -2277,9 +3136,9 @@ "plugin_url", "phase" ], - "pathType": "list", "parent": "/PluginService/Configurations/{Sid}", - "className": "configured_plugin" + "className": "configured_plugin", + "pathType": "list" }, "get": { "description": "", @@ -2346,16 +3205,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2364,21 +3225,104 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListConfiguredPluginResponse" + }, + "examples": { + "readEmpty": { + "value": { + "plugins": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/PluginService/Configurations/FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Plugins?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/PluginService/Configurations/FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Plugins?PageSize=50&Page=0", + "next_page_url": null, + "key": "plugins" + } + } + }, + "readFull": { + "value": { + "plugins": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "configuration_sid": "FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "plugin_sid": "FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "plugin_version_sid": "PVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "phase": 3, + "plugin_url": "https://sample.twil.io/plugin.js", + "unique_name": "sample-plugin", + "plugin_archived": false, + "friendly_name": "sample plugin", + "description": "the sample plugin", + "version": "1.0.0", + "plugin_version_archived": false, + "changelog": "this is a changelog", + "private": true, + "date_created": "2020-01-10T20:00:00Z", + "url": "https://flex-api.twilio.com/v1/PluginService/Configurations/FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/PluginService/Configurations/FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Plugins?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/PluginService/Configurations/FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Plugins?PageSize=50&Page=0", + "next_page_url": null, + "key": "plugins" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2390,10 +3334,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListConfiguredPlugin", - "x-maturity": [ - "GA" - ] + "operationId": "ListConfiguredPlugin" } }, "/v1/PluginService/Configurations/{ConfigurationSid}/Plugins/{PluginSid}": { @@ -2402,7 +3343,7 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "plugin_sid", @@ -2410,9 +3351,9 @@ "plugin_url", "phase" ], - "pathType": "instance", "parent": "/PluginService/Configurations/{Sid}", - "className": "configured_plugin" + "className": "configured_plugin", + "pathType": "instance" }, "get": { "description": "", @@ -2453,21 +3394,76 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.plugin_configuration.configured_plugin" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "configuration_sid": "FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "plugin_sid": "FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "plugin_version_sid": "PVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "phase": 3, + "plugin_url": "https://sample.twil.io/plugin.js", + "unique_name": "sample-plugin", + "plugin_archived": false, + "friendly_name": "sample plugin", + "description": "the sample plugin", + "version": "1.0.0", + "plugin_version_archived": false, + "changelog": "this is a changelog", + "private": true, + "date_created": "2020-01-10T20:00:00Z", + "url": "https://flex-api.twilio.com/v1/PluginService/Configurations/FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchConfiguredPlugin", - "x-maturity": [ - "GA" - ] + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchConfiguredPlugin" } }, "/v1/FlexFlows": { @@ -2484,8 +3480,8 @@ "channel_type", "integration_type" ], - "pathType": "list", - "mountName": "flex_flow" + "mountName": "flex_flow", + "pathType": "list" }, "get": { "description": "", @@ -2549,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" @@ -2567,21 +3565,105 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListFlexFlowResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2593,10 +3675,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListFlexFlow", - "x-maturity": [ - "GA" - ] + "operationId": "ListFlexFlow" }, "post": { "description": "", @@ -2609,6 +3688,65 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2621,9 +3759,6 @@ } ], "operationId": "CreateFlexFlow", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2720,6 +3855,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 + } + } } } } @@ -2740,8 +3891,8 @@ "channel_type", "integration_type" ], - "pathType": "instance", - "mountName": "flex_flow" + "mountName": "flex_flow", + "pathType": "instance" }, "get": { "description": "", @@ -2768,6 +3919,65 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2779,10 +3989,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchFlexFlow", - "x-maturity": [ - "GA" - ] + "operationId": "FetchFlexFlow" }, "post": { "description": "", @@ -2809,6 +4016,65 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2821,9 +4087,6 @@ } ], "operationId": "UpdateFlexFlow", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2915,12 +4178,25 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -2952,10 +4228,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteFlexFlow", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteFlexFlow" } }, "/v1/Insights/QualityManagement/Assessments": { @@ -2964,15 +4237,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.", @@ -2995,6 +4268,75 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3007,9 +4349,6 @@ } ], "operationId": "CreateInsightsAssessments", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3079,6 +4418,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" + } + } } } } @@ -3104,6 +4459,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" + } } }, { @@ -3148,16 +4511,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3166,21 +4531,115 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListInsightsAssessmentsResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3192,10 +4651,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListInsightsAssessments", - "x-maturity": [ - "Preview" - ] + "operationId": "ListInsightsAssessments" } }, "/v1/Insights/QualityManagement/Assessments/{AssessmentSid}": { @@ -3204,15 +4660,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", @@ -3247,6 +4703,75 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3259,9 +4784,6 @@ } ], "operationId": "UpdateInsightsAssessments", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3287,6 +4809,15 @@ "AnswerText", "AnswerId" ] + }, + "examples": { + "update": { + "value": { + "Offset": "6.985619", + "AnswerId": "ed8697d3-558d-46c3-9b73-cd21cd93cbb3", + "AnswerText": "Fair" + } + } } } } @@ -3299,15 +4830,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", @@ -3330,6 +4861,66 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3342,9 +4933,6 @@ } ], "operationId": "CreateInsightsAssessmentsComment", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3385,6 +4973,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" + } + } } } } @@ -3410,6 +5010,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" + } } }, { @@ -3418,6 +5026,11 @@ "description": "The id of the agent.", "schema": { "type": "string" + }, + "examples": { + "readByAgentId": { + "value": "5d80ee80-7608-55df-b2b2-5ab5608b9831" + } } }, { @@ -3462,16 +5075,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3480,21 +5095,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" } }, "title": "ListInsightsAssessmentsCommentResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3506,10 +5241,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListInsightsAssessmentsComment", - "x-maturity": [ - "Preview" - ] + "operationId": "ListInsightsAssessmentsComment" } }, "/v1/Insights/Conversations": { @@ -3518,7 +5250,7 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "conversation_id", @@ -3526,9 +5258,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", @@ -3550,6 +5282,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" + } } }, { @@ -3594,16 +5334,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3612,36 +5354,121 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListInsightsConversationsResponse" - } - } - }, - "description": "OK" - } + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } }, "security": [ { "accountSid_authToken": [] } ], - "operationId": "ListInsightsConversations", - "x-maturity": [ - "Preview" - ] + "operationId": "ListInsightsConversations" } }, "/v1/Insights/QualityManagement/Questionnaires": { @@ -3650,16 +5477,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", @@ -3682,6 +5509,80 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3694,9 +5595,6 @@ } ], "operationId": "CreateInsightsQuestionnaires", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3730,6 +5628,19 @@ "required": [ "Name" ] + }, + "examples": { + "create": { + "value": { + "Name": "abc", + "Description": "description", + "Active": false, + "QuestionSids": [ + "GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "GEeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee" + ] + } + } } } } @@ -3755,6 +5666,14 @@ "description": "Flag indicating whether to include inactive questionnaires or not", "schema": { "type": "boolean" + }, + "examples": { + "readEmpty": { + "value": true + }, + "readFull": { + "value": true + } } }, { @@ -3799,16 +5718,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3817,21 +5738,203 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListInsightsQuestionnairesResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3843,10 +5946,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListInsightsQuestionnaires", - "x-maturity": [ - "Preview" - ] + "operationId": "ListInsightsQuestionnaires" } }, "/v1/Insights/QualityManagement/Questionnaires/{QuestionnaireSid}": { @@ -3855,16 +5955,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", @@ -3899,6 +5999,80 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3911,9 +6085,6 @@ } ], "operationId": "UpdateInsightsQuestionnaires", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3947,6 +6118,19 @@ "required": [ "Active" ] + }, + "examples": { + "update": { + "value": { + "Name": "abc", + "Description": "description", + "Active": true, + "QuestionSids": [ + "GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "GEeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee" + ] + } + } } } } @@ -3989,10 +6173,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteInsightsQuestionnaires", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteInsightsQuestionnaires" }, "get": { "description": "To get the Questionnaire Detail", @@ -4027,6 +6208,80 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4038,10 +6293,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInsightsQuestionnaires", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchInsightsQuestionnaires" } }, "/v1/Insights/QualityManagement/Categories": { @@ -4050,15 +6302,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", @@ -4081,6 +6333,52 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4093,9 +6391,6 @@ } ], "operationId": "CreateInsightsQuestionnairesCategory", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4111,6 +6406,13 @@ "required": [ "Name" ] + }, + "examples": { + "create": { + "value": { + "Name": "abc" + } + } } } } @@ -4172,16 +6474,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4190,21 +6494,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" } }, "title": "ListInsightsQuestionnairesCategoryResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4216,10 +6591,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListInsightsQuestionnairesCategory", - "x-maturity": [ - "Preview" - ] + "operationId": "ListInsightsQuestionnairesCategory" } }, "/v1/Insights/QualityManagement/Categories/{CategorySid}": { @@ -4228,15 +6600,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", @@ -4271,6 +6643,52 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4283,9 +6701,6 @@ } ], "operationId": "UpdateInsightsQuestionnairesCategory", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4301,6 +6716,13 @@ "required": [ "Name" ] + }, + "examples": { + "update": { + "value": { + "Name": "abcd" + } + } } } } @@ -4343,10 +6765,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteInsightsQuestionnairesCategory", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteInsightsQuestionnairesCategory" } }, "/v1/Insights/QualityManagement/Questions": { @@ -4355,15 +6774,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", @@ -4386,6 +6805,83 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4398,9 +6894,6 @@ } ], "operationId": "CreateInsightsQuestionnairesQuestion", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4438,6 +6931,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 + } + } } } } @@ -4469,6 +6973,20 @@ "maxLength": 34, "pattern": "^FY[0-9a-fA-F]{32}$" } + }, + "examples": { + "readEmpty": { + "value": [ + "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FYeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee" + ] + }, + "readFull": { + "value": [ + "FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FYeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee" + ] + } } }, { @@ -4513,16 +7031,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4531,21 +7051,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" } }, "title": "ListInsightsQuestionnairesQuestionResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4557,10 +7179,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListInsightsQuestionnairesQuestion", - "x-maturity": [ - "Preview" - ] + "operationId": "ListInsightsQuestionnairesQuestion" } }, "/v1/Insights/QualityManagement/Questions/{QuestionSid}": { @@ -4569,15 +7188,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", @@ -4612,21 +7231,95 @@ "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" - } - }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateInsightsQuestionnairesQuestion", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4661,6 +7354,16 @@ "required": [ "AllowNa" ] + }, + "examples": { + "update": { + "value": { + "Question": "What is the total time", + "Description": "time spent", + "AnswerSetId": "a6a8a54f-5305-4aec-b92c-a6e429932f58", + "AllowNa": false + } + } } } } @@ -4703,10 +7406,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteInsightsQuestionnairesQuestion", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteInsightsQuestionnairesQuestion" } }, "/v1/Insights/Segments": { @@ -4715,7 +7415,7 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "segment_id", @@ -4724,9 +7424,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", @@ -4748,6 +7448,11 @@ "description": "To unique id of the segment", "schema": { "type": "string" + }, + "examples": { + "readBySegmentId": { + "value": "02dd8a65-c9e3-550b-9e98-5b11abb9b3a5" + } } }, { @@ -4762,6 +7467,20 @@ "maxLength": 34, "pattern": "^WR[0-9a-fA-F]{32}$" } + }, + "examples": { + "readEmpty": { + "value": [ + "WReeeff42d5326cfdaa0f7a1181d00f1b1", + "WReeeff42d5326cfdaa0f7a1181d00f1b2" + ] + }, + "readByReservationIds": { + "value": [ + "WReeeff42d5326cfdaa0f7a1181d00f1b1", + "WReeeff42d5326cfdaa0f7a1181d00f1b2" + ] + } } }, { @@ -4806,16 +7525,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4824,21 +7545,157 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListInsightsSegmentsResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4850,10 +7707,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListInsightsSegments", - "x-maturity": [ - "Preview" - ] + "operationId": "ListInsightsSegments" } }, "/v1/Insights/Session": { @@ -4862,7 +7716,7 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "workspace_id", @@ -4870,8 +7724,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", @@ -4894,6 +7748,53 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4905,10 +7806,7 @@ "accountSid_authToken": [] } ], - "operationId": "CreateInsightsSession", - "x-maturity": [ - "Preview" - ] + "operationId": "CreateInsightsSession" } }, "/v1/Insights/QualityManagement/Settings/AnswerSets": { @@ -4917,16 +7815,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", @@ -4949,6 +7847,122 @@ "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 + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4960,10 +7974,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInsightsSettingsAnswersets", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchInsightsSettingsAnswersets" } }, "/v1/Insights/QualityManagement/Settings/CommentTags": { @@ -4972,13 +7983,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", @@ -5001,6 +8012,58 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5012,10 +8075,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInsightsSettingsComment", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchInsightsSettingsComment" } }, "/v1/Insights/UserRoles": { @@ -5024,14 +8084,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", @@ -5054,6 +8114,52 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5065,10 +8171,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInsightsUserRoles", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchInsightsUserRoles" } }, "/v1/Interactions/{Sid}": { @@ -5077,12 +8180,11 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], - "pathType": "instance", "dependentProperties": { "channels": { "mapping": { @@ -5091,7 +8193,8 @@ "resource_url": "/v1/Interactions/{interaction_sid}/Channels" } }, - "mountName": "interaction" + "mountName": "interaction", + "pathType": "instance" }, "get": { "description": "", @@ -5118,6 +8221,67 @@ "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" + } + }, + "interaction_context_sid": null, + "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "channels": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5129,10 +8293,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInteraction", - "x-maturity": [ - "GA" - ] + "operationId": "FetchInteraction" } }, "/v1/Interactions": { @@ -5141,12 +8302,11 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], - "pathType": "list", "dependentProperties": { "channels": { "mapping": { @@ -5155,7 +8315,8 @@ "resource_url": "/v1/Interactions/{interaction_sid}/Channels" } }, - "mountName": "interaction" + "mountName": "interaction", + "pathType": "list" }, "post": { "description": "Create a new Interaction.", @@ -5168,6 +8329,85 @@ "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" + } + }, + "interaction_context_sid": null, + "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "channels": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5180,9 +8420,6 @@ } ], "operationId": "CreateInteraction", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5207,6 +8444,15 @@ "required": [ "Channel" ] + }, + "examples": { + "create": { + "value": { + "Channel": "{\"type\":\"sms\",\"initiated_by\":\"customer\"}", + "Routing": "{}", + "InteractionContextSid": "interaction_context_sid" + } + } } } } @@ -5219,12 +8465,11 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], - "pathType": "instance", "dependentProperties": { "invites": { "mapping": { @@ -5242,7 +8487,8 @@ } }, "parent": "/Interactions/{Sid}", - "className": "interaction_channel" + "className": "interaction_channel", + "pathType": "instance" }, "get": { "description": "Fetch a Channel for an Interaction.", @@ -5281,6 +8527,59 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5292,10 +8591,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInteractionChannel", - "x-maturity": [ - "GA" - ] + "operationId": "FetchInteractionChannel" }, "post": { "description": "Update an existing Interaction Channel.", @@ -5334,6 +8630,89 @@ "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" + } + } + }, + "updateStatusInactive": { + "value": { + "sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1", + "interaction_sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "email", + "status": "inactive", + "error_code": null, + "error_message": "", + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5346,9 +8725,6 @@ } ], "operationId": "UpdateInteractionChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5368,6 +8744,24 @@ "required": [ "Status" ] + }, + "examples": { + "update": { + "value": { + "Status": "closed" + } + }, + "updateStatusClosed": { + "value": { + "Status": "closed" + } + }, + "updateStatusInactive": { + "value": { + "Status": "inactive", + "Routing": "{\"status\":\"closed\"}" + } + } } } } @@ -5380,12 +8774,11 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], - "pathType": "list", "dependentProperties": { "invites": { "mapping": { @@ -5403,7 +8796,8 @@ } }, "parent": "/Interactions/{Sid}", - "className": "interaction_channel" + "className": "interaction_channel", + "pathType": "list" }, "get": { "description": "List all Channels for an Interaction.", @@ -5465,16 +8859,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5483,21 +8879,137 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListInteractionChannelResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5509,10 +9021,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListInteractionChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListInteractionChannel" } }, "/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Invites": { @@ -5521,14 +9030,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.", @@ -5567,9 +9076,82 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, "description": "Created" } }, @@ -5579,9 +9161,6 @@ } ], "operationId": "CreateInteractionChannelInvite", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5596,6 +9175,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\"}}}" + } + } } } } @@ -5673,16 +9259,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5691,21 +9279,138 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListInteractionChannelInviteResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5717,10 +9422,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListInteractionChannelInvite", - "x-maturity": [ - "GA" - ] + "operationId": "ListInteractionChannelInvite" } }, "/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants": { @@ -5729,14 +9431,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.", @@ -5775,6 +9477,58 @@ "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", + "routing_properties": { + "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reservation_sid": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5787,9 +9541,6 @@ } ], "operationId": "CreateInteractionChannelParticipant", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5813,6 +9564,15 @@ "Type", "MediaProperties" ] + }, + "examples": { + "create": { + "value": { + "Type": "customer", + "MediaProperties": "{\"level\": \"to\", \"name\": \"Random Person test\", \"address\":\"random@person.com\", \"type\": \"email\"}", + "RoutingProperties": "{\"task_sid\": \"WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\", \"worker_sid\": \"WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\", \"reservation_sid\": \"WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"}" + } + } } } } @@ -5890,16 +9650,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5908,21 +9670,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" } }, "title": "ListInteractionChannelParticipantResponse" + }, + "examples": { + "read": { + "value": { + "participants": [ + { + "sid": "UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1", + "channel_sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1", + "interaction_sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "customer", + "routing_properties": null, + "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1" + }, + { + "sid": "UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2", + "channel_sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1", + "interaction_sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "agent", + "routing_properties": { + "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reservation_sid": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5934,10 +9767,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListInteractionChannelParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "ListInteractionChannelParticipant" } }, "/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants/{Sid}": { @@ -5946,14 +9776,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.", @@ -6004,6 +9834,72 @@ "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", + "routing_properties": { + "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reservation_sid": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "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", + "routing_properties": { + "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "reservation_sid": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6016,9 +9912,6 @@ } ], "operationId": "UpdateInteractionChannelParticipant", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6035,6 +9928,18 @@ "required": [ "Status" ] + }, + "examples": { + "update": { + "value": { + "Status": "closed" + } + }, + "updateStatusClosed": { + "value": { + "Status": "closed" + } + } } } } @@ -6047,14 +9952,13 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "friendly_name" ], - "pathType": "list", "dependentProperties": { "plugin_versions": { "mapping": { @@ -6062,7 +9966,8 @@ }, "resource_url": "/v1/PluginService/Plugins/{plugin_sid}/Versions" } - } + }, + "pathType": "list" }, "get": { "description": "", @@ -6120,16 +10025,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -6138,21 +10045,100 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListPluginResponse" + }, + "examples": { + "readEmpty": { + "value": { + "plugins": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/PluginService/Plugins?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/PluginService/Plugins?PageSize=50&Page=0", + "next_page_url": null, + "key": "plugins" + } + } + }, + "readFull": { + "value": { + "plugins": [ + { + "sid": "FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique-name", + "friendly_name": "friendly name", + "description": "description", + "archived": false, + "date_created": "2020-01-10T20:00:00Z", + "date_updated": "2020-01-10T20:00:00Z", + "url": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "plugin_versions": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/PluginService/Plugins?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/PluginService/Plugins?PageSize=50&Page=0", + "next_page_url": null, + "key": "plugins" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6164,10 +10150,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListPlugin", - "x-maturity": [ - "GA" - ] + "operationId": "ListPlugin" }, "post": { "description": "", @@ -6190,6 +10173,60 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.plugin" + }, + "examples": { + "create": { + "value": { + "sid": "FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique-name", + "friendly_name": "friendly name", + "description": "description", + "archived": false, + "date_created": "2020-01-10T20:00:00Z", + "date_updated": "2020-01-10T20:00:00Z", + "url": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "plugin_versions": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6202,9 +10239,6 @@ } ], "operationId": "CreatePlugin", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6228,6 +10262,15 @@ "required": [ "UniqueName" ] + }, + "examples": { + "create": { + "value": { + "UniqueName": "unique-name", + "FriendlyName": "friendly name", + "Description": "description" + } + } } } } @@ -6240,14 +10283,13 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "friendly_name" ], - "pathType": "instance", "dependentProperties": { "plugin_versions": { "mapping": { @@ -6255,7 +10297,8 @@ }, "resource_url": "/v1/PluginService/Plugins/{plugin_sid}/Versions" } - } + }, + "pathType": "instance" }, "get": { "description": "", @@ -6287,6 +10330,60 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.plugin" + }, + "examples": { + "fetch": { + "value": { + "sid": "FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique-name", + "friendly_name": "friendly name", + "description": "description", + "archived": false, + "date_created": "2020-01-10T20:00:00Z", + "date_updated": "2020-01-10T20:00:00Z", + "url": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "plugin_versions": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6298,10 +10395,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchPlugin", - "x-maturity": [ - "GA" - ] + "operationId": "FetchPlugin" }, "post": { "description": "", @@ -6333,6 +10427,60 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.plugin" + }, + "examples": { + "update": { + "value": { + "sid": "FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique-name", + "friendly_name": "friendly name update", + "description": "description update", + "archived": false, + "date_created": "2020-01-10T20:00:00Z", + "date_updated": "2020-01-10T20:00:00Z", + "url": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "plugin_versions": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6345,9 +10493,6 @@ } ], "operationId": "UpdatePlugin", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6364,12 +10509,17 @@ "description": "A descriptive string that you update to describe the plugin resource. It can be up to 500 characters long" } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly name update", + "Description": "description update" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -6379,15 +10529,15 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "friendly_name" ], - "pathType": "instance", - "mountName": "plugin_archive" + "mountName": "plugin_archive", + "pathType": "instance" }, "post": { "description": "", @@ -6419,6 +10569,57 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.plugin_archive" + }, + "examples": { + "updateArchive": { + "value": { + "sid": "FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique-name", + "friendly_name": "friendly name update", + "description": "description update", + "archived": true, + "date_created": "2020-01-10T20:00:00Z", + "date_updated": "2020-01-10T20:00:00Z", + "url": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Archive" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6430,10 +10631,7 @@ "accountSid_authToken": [] } ], - "operationId": "UpdatePluginArchive", - "x-maturity": [ - "GA" - ] + "operationId": "UpdatePluginArchive" } }, "/v1/PluginService/Configurations": { @@ -6442,14 +10640,13 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "name", "description" ], - "pathType": "list", "dependentProperties": { "plugins": { "mapping": { @@ -6458,7 +10655,8 @@ "resource_url": "/v1/PluginService/Configurations/{configuration_sid}/Plugins" } }, - "mountName": "plugin_configurations" + "mountName": "plugin_configurations", + "pathType": "list" }, "get": { "description": "", @@ -6516,16 +10714,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -6534,36 +10734,110 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListPluginConfigurationResponse" + }, + "examples": { + "readEmpty": { + "value": { + "configurations": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/PluginService/Configurations?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/PluginService/Configurations?PageSize=50&Page=0", + "next_page_url": null, + "key": "configurations" + } + } + }, + "readFull": { + "value": { + "configurations": [ + { + "sid": "FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "some name", + "description": "description", + "archived": false, + "date_created": "2020-01-10T20:00:00Z", + "url": "https://flex-api.twilio.com/v1/PluginService/Configurations/FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "plugins": "https://flex-api.twilio.com/v1/PluginService/Configurations/FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Plugins" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/PluginService/Configurations?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/PluginService/Configurations?PageSize=50&Page=0", + "next_page_url": null, + "key": "configurations" + } + } + } } } }, - "description": "OK" - } - }, - "security": [ + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ { "accountSid_authToken": [] } ], - "operationId": "ListPluginConfiguration", - "x-maturity": [ - "GA" - ] + "operationId": "ListPluginConfiguration" }, "post": { "description": "", @@ -6586,6 +10860,58 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.plugin_configuration" + }, + "examples": { + "create": { + "value": { + "sid": "FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "some name", + "description": "description", + "archived": false, + "date_created": "2020-01-10T20:00:00Z", + "url": "https://flex-api.twilio.com/v1/PluginService/Configurations/FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "plugins": "https://flex-api.twilio.com/v1/PluginService/Configurations/FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Plugins" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6598,9 +10924,6 @@ } ], "operationId": "CreatePluginConfiguration", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6625,6 +10948,17 @@ "required": [ "Name" ] + }, + "examples": { + "create": { + "value": { + "Name": "some name", + "Description": "description", + "Plugins": [ + "{\"plugin_version\": \"FVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\", \"phase\": 3}" + ] + } + } } } } @@ -6637,14 +10971,13 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "name", "description" ], - "pathType": "instance", "dependentProperties": { "plugins": { "mapping": { @@ -6653,7 +10986,8 @@ "resource_url": "/v1/PluginService/Configurations/{configuration_sid}/Plugins" } }, - "mountName": "plugin_configurations" + "mountName": "plugin_configurations", + "pathType": "instance" }, "get": { "description": "", @@ -6688,6 +11022,58 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.plugin_configuration" + }, + "examples": { + "fetch": { + "value": { + "sid": "FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "some name", + "description": "description", + "archived": false, + "date_created": "2020-01-10T20:00:00Z", + "url": "https://flex-api.twilio.com/v1/PluginService/Configurations/FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "plugins": "https://flex-api.twilio.com/v1/PluginService/Configurations/FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Plugins" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6699,10 +11085,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchPluginConfiguration", - "x-maturity": [ - "GA" - ] + "operationId": "FetchPluginConfiguration" } }, "/v1/PluginService/Configurations/{Sid}/Archive": { @@ -6711,15 +11094,15 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "name", "description" ], - "pathType": "instance", - "mountName": "plugin_configuration_archive" + "mountName": "plugin_configuration_archive", + "pathType": "instance" }, "post": { "description": "", @@ -6754,6 +11137,55 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.plugin_configuration_archive" + }, + "examples": { + "updateArchive": { + "value": { + "sid": "FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "some name", + "description": "description", + "archived": true, + "date_created": "2020-01-10T20:00:00Z", + "url": "https://flex-api.twilio.com/v1/PluginService/Configurations/FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Archive" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6765,10 +11197,7 @@ "accountSid_authToken": [] } ], - "operationId": "UpdatePluginConfigurationArchive", - "x-maturity": [ - "GA" - ] + "operationId": "UpdatePluginConfigurationArchive" } }, "/v1/PluginService/Releases": { @@ -6777,15 +11206,15 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "configuration_sid", "date_created" ], - "pathType": "list", - "mountName": "plugin_releases" + "mountName": "plugin_releases", + "pathType": "list" }, "get": { "description": "", @@ -6843,16 +11272,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -6861,21 +11292,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" } }, "title": "ListPluginReleaseResponse" + }, + "examples": { + "readEmpty": { + "value": { + "releases": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/PluginService/Releases?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/PluginService/Releases?PageSize=50&Page=0", + "next_page_url": null, + "key": "releases" + } + } + }, + "readFull": { + "value": { + "releases": [ + { + "sid": "FKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "configuration_sid": "FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2020-01-10T20:00:00Z", + "url": "https://flex-api.twilio.com/v1/PluginService/Releases/FKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/PluginService/Releases?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/PluginService/Releases?PageSize=50&Page=0", + "next_page_url": null, + "key": "releases" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6887,10 +11390,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListPluginRelease", - "x-maturity": [ - "GA" - ] + "operationId": "ListPluginRelease" }, "post": { "description": "", @@ -6913,6 +11413,53 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.plugin_release" + }, + "examples": { + "create": { + "value": { + "sid": "FKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "configuration_sid": "FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2020-01-10T20:00:00Z", + "url": "https://flex-api.twilio.com/v1/PluginService/Releases/FKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6925,9 +11472,6 @@ } ], "operationId": "CreatePluginRelease", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6943,6 +11487,13 @@ "required": [ "ConfigurationId" ] + }, + "examples": { + "create": { + "value": { + "ConfigurationId": "FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -6955,15 +11506,15 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "configuration_sid", "date_created" ], - "pathType": "instance", - "mountName": "plugin_releases" + "mountName": "plugin_releases", + "pathType": "instance" }, "get": { "description": "", @@ -6995,6 +11546,62 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.plugin_release" + }, + "examples": { + "fetchActive": { + "value": { + "sid": "FKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "configuration_sid": "FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2020-01-10T20:00:00Z", + "url": "https://flex-api.twilio.com/v1/PluginService/Releases/FKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "fetch": { + "value": { + "sid": "FKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "configuration_sid": "FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2020-01-10T20:00:00Z", + "url": "https://flex-api.twilio.com/v1/PluginService/Releases/FKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -7006,10 +11613,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchPluginRelease", - "x-maturity": [ - "GA" - ] + "operationId": "FetchPluginRelease" } }, "/v1/PluginService/Plugins/{PluginSid}/Versions": { @@ -7018,17 +11622,17 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "plugin_sid", "version" ], - "pathType": "list", "parent": "/PluginService/Plugins/{Sid}", "mountName": "plugin_versions", - "className": "plugin_versions" + "className": "plugin_versions", + "pathType": "list" }, "get": { "description": "", @@ -7095,16 +11699,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -7113,21 +11719,99 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListPluginVersionResponse" + }, + "examples": { + "readEmpty": { + "value": { + "plugin_versions": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions?PageSize=50&Page=0", + "next_page_url": null, + "key": "plugin_versions" + } + } + }, + "readFull": { + "value": { + "plugin_versions": [ + { + "sid": "FVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "plugin_sid": "FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "version": "1.0.0", + "plugin_url": "https://sample.twil.io/plugin.js", + "changelog": "the changelog", + "private": false, + "archived": false, + "validated": false, + "date_created": "2020-01-10T20:00:00Z", + "url": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions/FVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions?PageSize=50&Page=0", + "next_page_url": null, + "key": "plugin_versions" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -7139,10 +11823,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListPluginVersion", - "x-maturity": [ - "GA" - ] + "operationId": "ListPluginVersion" }, "post": { "description": "", @@ -7174,6 +11855,89 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.plugin.plugin_version" + }, + "examples": { + "create": { + "value": { + "sid": "FVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "plugin_sid": "FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "version": "1.0.0", + "plugin_url": "https://sample.twil.io/plugin.js", + "changelog": "the changelog", + "private": true, + "archived": false, + "validated": false, + "date_created": "2020-01-10T20:00:00Z", + "url": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions/FVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createWithCliVersion": { + "value": { + "sid": "FVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "plugin_sid": "FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "version": "1.0.0", + "plugin_url": "https://sample.twil.io/plugin.js", + "changelog": "the changelog", + "private": true, + "archived": false, + "validated": false, + "date_created": "2020-01-10T20:00:00Z", + "url": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions/FVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createWithCliAndValidateStatus": { + "value": { + "sid": "FVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "plugin_sid": "FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "version": "1.0.0", + "plugin_url": "https://sample.twil.io/plugin.js", + "changelog": "the changelog", + "private": true, + "archived": false, + "validated": true, + "date_created": "2020-01-10T20:00:00Z", + "url": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions/FVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -7186,9 +11950,6 @@ } ], "operationId": "CreatePluginVersion", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -7226,6 +11987,35 @@ "Version", "PluginUrl" ] + }, + "examples": { + "create": { + "value": { + "Version": "1.0.0", + "PluginUrl": "https://sample.twil.io/plugin.js", + "Changelog": "the changelog", + "Private": true + } + }, + "createWithCliVersion": { + "value": { + "Version": "1.0.0", + "PluginUrl": "https://sample.twil.io/plugin.js", + "Changelog": "the changelog", + "Private": true, + "CliVersion": "6.3.2" + } + }, + "createWithCliAndValidateStatus": { + "value": { + "Version": "1.0.0", + "PluginUrl": "https://sample.twil.io/plugin.js", + "Changelog": "the changelog", + "Private": true, + "CliVersion": "6.3.2", + "ValidateStatus": "success" + } + } } } } @@ -7238,17 +12028,17 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "plugin_sid", "version" ], - "pathType": "instance", "parent": "/PluginService/Plugins/{Sid}", "mountName": "plugin_versions", - "className": "plugin_versions" + "className": "plugin_versions", + "pathType": "instance" }, "get": { "description": "", @@ -7289,6 +12079,59 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.plugin.plugin_version" + }, + "examples": { + "fetch": { + "value": { + "sid": "FVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "plugin_sid": "FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "version": "1.0.0", + "plugin_url": "https://sample.twil.io/plugin.js", + "changelog": "the changelog", + "private": false, + "archived": false, + "validated": false, + "date_created": "2020-01-10T20:00:00Z", + "url": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions/FVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -7300,10 +12143,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchPluginVersion", - "x-maturity": [ - "GA" - ] + "operationId": "FetchPluginVersion" } }, "/v1/PluginService/Plugins/{PluginSid}/Versions/{Sid}/Archive": { @@ -7312,15 +12152,15 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "plugin_sid", "version" ], - "pathType": "instance", - "mountName": "plugin_version_archive" + "mountName": "plugin_version_archive", + "pathType": "instance" }, "post": { "description": "", @@ -7361,6 +12201,58 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.plugin_version_archive" + }, + "examples": { + "updateArchive": { + "value": { + "sid": "FVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "plugin_sid": "FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "version": "1.0.0", + "plugin_url": "https://sample.twil.io/plugin.js", + "changelog": "the changelog", + "private": false, + "archived": true, + "date_created": "2020-01-10T20:00:00Z", + "url": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions/FVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Archive" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -7372,10 +12264,7 @@ "accountSid_authToken": [] } ], - "operationId": "UpdatePluginVersionArchive", - "x-maturity": [ - "GA" - ] + "operationId": "UpdatePluginVersionArchive" } }, "/v1/account/provision/status": { @@ -7389,8 +12278,8 @@ "defaultOutputProperties": [ "status" ], - "pathType": "instance", - "mountName": "provisioning_status" + "mountName": "provisioning_status", + "pathType": "instance" }, "get": { "description": "", @@ -7403,6 +12292,50 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v1.provisioning_status" + }, + "examples": { + "fetch": { + "value": { + "status": "active", + "url": "https://flex-api.twilio.com/v1/account/provision/status" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -7414,10 +12347,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchProvisioningStatus", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchProvisioningStatus" } }, "/v1/WebChannels": { @@ -7426,14 +12356,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": "", @@ -7483,16 +12413,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -7501,21 +12433,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" } }, "title": "ListWebChannelResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -7527,10 +12532,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListWebChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListWebChannel" }, "post": { "description": "", @@ -7543,6 +12545,54 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -7555,9 +12605,6 @@ } ], "operationId": "CreateWebChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -7599,6 +12646,17 @@ "CustomerFriendlyName", "ChatFriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FlexFlowSid": "FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Identity": "abc", + "ChatFriendlyName": "firendly1", + "CustomerFriendlyName": "friendly2", + "PreEngagementData": "{}" + } + } } } } @@ -7611,14 +12669,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": "", @@ -7645,6 +12703,54 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -7656,10 +12762,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWebChannel", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWebChannel" }, "post": { "description": "", @@ -7686,6 +12789,54 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -7698,9 +12849,6 @@ } ], "operationId": "UpdateWebChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -7718,12 +12866,17 @@ "description": "The post-engagement data." } } + }, + "examples": { + "update": { + "value": { + "ChatStatus": "inactive", + "PostEngagementData": "{}" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -7755,10 +12908,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteWebChannel", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteWebChannel" } } }, @@ -7768,12 +12918,24 @@ } ], "tags": [ + { + "name": "FlexV1AiInsights" + }, + { + "name": "FlexV1AiInsightsConversations" + }, { "name": "FlexV1Assessments" }, { "name": "FlexV1Channel" }, + { + "name": "FlexV1ChannelParticipantTwiml" + }, + { + "name": "FlexV1ChannelUser" + }, { "name": "FlexV1Configuration" }, @@ -7783,9 +12945,18 @@ { "name": "FlexV1FlexFlow" }, + { + "name": "FlexV1FlexUser" + }, + { + "name": "FlexV1FlexVideoOrchestration" + }, { "name": "FlexV1InsightsAssessmentsComment" }, + { + "name": "FlexV1InsightsConversationalAi" + }, { "name": "FlexV1InsightsConversations" }, @@ -7819,12 +12990,45 @@ { "name": "FlexV1InteractionChannel" }, + { + "name": "FlexV1InteractionChannelApp" + }, { "name": "FlexV1InteractionChannelInvite" }, { "name": "FlexV1InteractionChannelParticipant" }, + { + "name": "FlexV1InteractionContext" + }, + { + "name": "FlexV1InteractionContextLookup" + }, + { + "name": "FlexV1InteractionContextLookupId" + }, + { + "name": "FlexV1InteractionContextLookupSid" + }, + { + "name": "FlexV1InteractionContextUpdate" + }, + { + "name": "FlexV1LibraryPlugin" + }, + { + "name": "FlexV1LibraryPluginDetail" + }, + { + "name": "FlexV1LibraryPluginVariable" + }, + { + "name": "FlexV1LibraryPluginVariableUpdate" + }, + { + "name": "FlexV1LibraryPluginsUpdate" + }, { "name": "FlexV1Plugin" }, @@ -7850,21 +13054,21 @@ "name": "FlexV1ProvisioningStatus" }, { - "name": "FlexV1WebChannel" - } - ], - "x-maturity": [ + "name": "FlexV1PublicConfiguration" + }, { - "name": "GA", - "description": "This product is Generally Available." + "name": "FlexV1Transfer" }, { - "name": "Beta", - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." + "name": "FlexV1VirtualAgentData" }, { - "name": "Preview", - "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact https://www.twilio.com/help/contact." + "name": "FlexV1WebChannel" + } + ], + "security": [ + { + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_flex_v2.json b/src/services/twilio-api/twilio_flex_v2.json index 82064ae7..51ca8cfd 100644 --- a/src/services/twilio-api/twilio_flex_v2.json +++ b/src/services/twilio-api/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.flex_user": { "type": "object", "properties": { @@ -127,12 +152,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -148,7 +167,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -158,7 +177,7 @@ "url": "https://flex-api.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "account_sid", @@ -167,8 +186,8 @@ "user_sid", "created_date" ], - "pathType": "instance", - "mountName": "flex_user" + "mountName": "flex_user", + "pathType": "instance" }, "get": { "description": "Fetch flex user for the given flex user sid", @@ -207,6 +226,64 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v2.flex_user" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "instance_sid": "GOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "flex_user_sid": "FUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "flex_team_sid": "QOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "first_name": "firstname", + "last_name": "lastname", + "friendly_name": "friendly_name", + "username": "username", + "email": "sample@example.com", + "created_date": "2015-07-31T04:00:00Z", + "updated_date": "2015-07-31T04:00:00Z", + "version": 1, + "url": "https://flex-api.twilio.com/v2/Instances/GOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/FUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -218,10 +295,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchFlexUser", - "x-maturity": [ - "GA" - ] + "operationId": "FetchFlexUser" } }, "/v2/WebChats": { @@ -230,14 +304,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": "", @@ -260,6 +334,50 @@ "application/json": { "schema": { "$ref": "#/components/schemas/flex.v2.web_channel" + }, + "examples": { + "create": { + "value": { + "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "seinfeld" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -272,9 +390,6 @@ } ], "operationId": "CreateWebChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -302,6 +417,15 @@ "required": [ "AddressSid" ] + }, + "examples": { + "create": { + "value": { + "AddressSid": "IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ChatFriendlyName": "LoquaciousLarry", + "CustomerFriendlyName": "LarryDavid" + } + } } } } @@ -315,17 +439,28 @@ } ], "tags": [ + { + "name": "FlexV2ConductorFlow" + }, { "name": "FlexV2FlexUser" }, + { + "name": "FlexV2User" + }, { "name": "FlexV2WebChannels" + }, + { + "name": "FlexV2WebchatInitToken" + }, + { + "name": "FlexV2WebchatRefreshToken" } ], - "x-maturity": [ + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_frontline_v1.json b/src/services/twilio-api/twilio_frontline_v1.json index e34ed9f8..30fdeb53 100644 --- a/src/services/twilio-api/twilio_frontline_v1.json +++ b/src/services/twilio-api/twilio_frontline_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "frontline.v1.user": { "type": "object", @@ -65,12 +71,6 @@ "deactivated" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -86,7 +86,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -126,6 +126,55 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -137,10 +186,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUser", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchUser" }, "post": { "description": "Update an existing frontline user", @@ -164,6 +210,55 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -176,9 +271,6 @@ } ], "operationId": "UpdateUser", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -204,12 +296,19 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } } @@ -224,10 +323,9 @@ "name": "FrontlineV1User" } ], - "x-maturity": [ + "security": [ { - "name": "Beta", - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_insights_v1.json b/src/services/twilio-api/twilio_insights_v1.json index a8e0671c..09efea50 100644 --- a/src/services/twilio-api/twilio_insights_v1.json +++ b/src/services/twilio-api/twilio_insights_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "insights.v1.account_settings": { "type": "object", @@ -1524,12 +1530,6 @@ "tokyo" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -1545,7 +1545,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -1555,7 +1555,7 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "advanced_features", @@ -1587,6 +1587,52 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1598,10 +1644,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAccountSettings", - "x-maturity": [ - "GA" - ] + "operationId": "FetchAccountSettings" }, "post": { "description": "Update a specific Voice Insights Setting.", @@ -1614,6 +1657,52 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1626,9 +1715,6 @@ } ], "operationId": "UpdateAccountSettings", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1652,12 +1738,18 @@ "description": "The unique SID identifier of the Subaccount." } } + }, + "examples": { + "update": { + "value": { + "VoiceTrace": true, + "AdvancedFeatures": true, + "SubaccountSid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -1667,14 +1759,14 @@ "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": "Update an Annotation for a specific Call.", @@ -1701,6 +1793,61 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1713,9 +1860,6 @@ } ], "operationId": "UpdateAnnotation", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1755,12 +1899,22 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -1788,6 +1942,60 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1799,10 +2007,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAnnotation", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchAnnotation" } }, "/v1/Voice/{Sid}": { @@ -1811,10 +2016,9 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", "dependentProperties": { "events": { "mapping": { @@ -1841,7 +2045,8 @@ "resource_url": "/v1/Voice/{call_sid}/Annotation" } }, - "mountName": "calls" + "mountName": "calls", + "pathType": "instance" }, "get": { "description": "", @@ -1868,6 +2073,56 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1879,10 +2134,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCall", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCall" } }, "/v1/Voice/Summaries": { @@ -1891,7 +2143,7 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "account_sid", @@ -1904,9 +2156,9 @@ "call_type", "call_state" ], - "pathType": "list", "mountName": "call_summaries", - "className": "call_summaries" + "className": "call_summaries", + "pathType": "list" }, "get": { "description": "Get a list of Call Summaries.", @@ -1956,6 +2208,11 @@ "description": "A destination carrier.", "schema": { "type": "string" + }, + "examples": { + "readWithCarrier": { + "value": "AT&T Wireless" + } } }, { @@ -1988,6 +2245,11 @@ "description": "A boolean flag indicating whether or not the caller was verified using SHAKEN/STIR.", "schema": { "type": "boolean" + }, + "examples": { + "readWithTrust": { + "value": true + } } }, { @@ -1996,6 +2258,11 @@ "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 + } } }, { @@ -2004,6 +2271,20 @@ "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" + } } }, { @@ -2020,6 +2301,14 @@ "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" + } } }, { @@ -2028,6 +2317,11 @@ "description": "A Call State of the calls. One of `ringing`, `completed`, `busy`, `fail`, `noanswer`, `canceled`, `answered`, `undialed`.", "schema": { "type": "string" + }, + "examples": { + "readWithAbnormalSession": { + "value": "completed" + } } }, { @@ -2036,6 +2330,11 @@ "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" + } } }, { @@ -2065,6 +2364,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$" + }, + "examples": { + "readWithSubaccount": { + "value": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + } } }, { @@ -2073,6 +2377,11 @@ "description": "A boolean flag indicating an abnormal session where the last SIP response was not 200 OK.", "schema": { "type": "boolean" + }, + "examples": { + "readWithAbnormalSession": { + "value": true + } } }, { @@ -2082,6 +2391,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/call_summaries_enum_answered_by" + }, + "examples": { + "readWithCarrier": { + "value": "machine_start" + } } }, { @@ -2090,6 +2404,11 @@ "description": "Either machine or human.", "schema": { "type": "string" + }, + "examples": { + "readWithAnnotationParameters": { + "value": "human" + } } }, { @@ -2098,6 +2417,11 @@ "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" + } } }, { @@ -2106,6 +2430,11 @@ "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" + } } }, { @@ -2114,6 +2443,11 @@ "description": "A boolean flag indicating spam calls.", "schema": { "type": "boolean" + }, + "examples": { + "readWithAnnotationParameters": { + "value": true + } } }, { @@ -2122,6 +2456,11 @@ "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" + } } }, { @@ -2166,16 +2505,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2184,21 +2525,1089 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListCallSummariesResponse" + }, + "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?AnsweredByAnnotation=human&SpamAnnotation=True&CallScoreAnnotation=1%2C2&ConnectivityIssueAnnotation=invalid_number%2Cdropped_call&QualityIssueAnnotation=choppy_robotic%2Cecho&PageSize=25&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "call_summaries", + "url": "https://insights.twilio.com/v1/Voice/Summaries?AnsweredByAnnotation=human&SpamAnnotation=True&CallScoreAnnotation=1%2C2&ConnectivityIssueAnnotation=invalid_number%2Cdropped_call&QualityIssueAnnotation=choppy_robotic%2Cecho&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": { + "answered_by": "human", + "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": { + "answered_by": "human", + "spam": true, + "connectivity_issue": "invalid_number", + "quality_issues": [ + "choppy_robotic" + ], + "call_score": 1 + }, + "url": "https://insights.twilio.com/v1/Voice/Summaries" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2210,10 +3619,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCallSummaries", - "x-maturity": [ - "GA" - ] + "operationId": "ListCallSummaries" } }, "/v1/Conferences/{ConferenceSid}": { @@ -2222,13 +3628,12 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "conference_sid", "account_sid" ], - "pathType": "instance", "dependentProperties": { "conference_participants": { "mapping": { @@ -2236,7 +3641,8 @@ }, "resource_url": "/v1/Conferences/{conference_sid}/Participants" } - } + }, + "pathType": "instance" }, "get": { "description": "Get a specific Conference Summary.", @@ -2263,6 +3669,91 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2274,10 +3765,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConference", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConference" } }, "/v1/Conferences": { @@ -2286,13 +3774,12 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "conference_sid", "account_sid" ], - "pathType": "list", "dependentProperties": { "conference_participants": { "mapping": { @@ -2300,7 +3787,8 @@ }, "resource_url": "/v1/Conferences/{conference_sid}/Participants" } - } + }, + "pathType": "list" }, "get": { "description": "Get a list of Conference Summaries.", @@ -2328,6 +3816,11 @@ "handling": "standard", "deleteSla": 30 } + }, + "examples": { + "readWithFriendlynameStartfailure": { + "value": "outboundConfCallTransferThrice_1" + } } }, { @@ -2336,6 +3829,14 @@ "description": "Conference status.", "schema": { "type": "string" + }, + "examples": { + "readWithRegion": { + "value": "completed" + }, + "readWithFriendlynameStartfailure": { + "value": "not_started" + } } }, { @@ -2344,6 +3845,11 @@ "description": "Conferences created after the provided timestamp specified in ISO 8601 format", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "2021-10-09T17:20:53Z" + } } }, { @@ -2352,6 +3858,11 @@ "description": "Conferences created before the provided timestamp specified in ISO 8601 format.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "2021-10-12T18:37:53Z" + } } }, { @@ -2360,6 +3871,11 @@ "description": "Twilio region where the conference media was mixed.", "schema": { "type": "string" + }, + "examples": { + "readWithRegion": { + "value": "au1" + } } }, { @@ -2368,6 +3884,11 @@ "description": "Tags applied by Twilio for common potential configuration, quality, or performance issues.", "schema": { "type": "string" + }, + "examples": { + "readWithDuplicateIdentity": { + "value": "duplicate_identity" + } } }, { @@ -2387,6 +3908,11 @@ "description": "Potential configuration, behavior, or performance issues detected during the conference.", "schema": { "type": "string" + }, + "examples": { + "readWithDetectedIssueEndreason": { + "value": "call_quality" + } } }, { @@ -2395,6 +3921,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" + } } }, { @@ -2439,16 +3970,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2457,21 +3990,386 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListConferenceResponse" + }, + "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" + } + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2483,10 +4381,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListConference", - "x-maturity": [ - "GA" - ] + "operationId": "ListConference" } }, "/v1/Conferences/{ConferenceSid}/Participants/{ParticipantSid}": { @@ -2495,7 +4390,7 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "participant_sid", @@ -2503,9 +4398,9 @@ "call_sid", "account_sid" ], - "pathType": "instance", "parent": "/Conferences/{ConferenceSid}", - "mountName": "conference_participants" + "mountName": "conference_participants", + "pathType": "instance" }, "get": { "description": "Get a specific Conference Participant Summary for a Conference.", @@ -2560,6 +4455,115 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2571,10 +4575,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConferenceParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConferenceParticipant" } }, "/v1/Conferences/{ConferenceSid}/Participants": { @@ -2583,7 +4584,7 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "participant_sid", @@ -2591,9 +4592,9 @@ "call_sid", "account_sid" ], - "pathType": "list", "parent": "/Conferences/{ConferenceSid}", - "mountName": "conference_participants" + "mountName": "conference_participants", + "pathType": "list" }, "get": { "description": "Get a list of Conference Participants Summaries for a Conference.", @@ -2633,6 +4634,11 @@ "handling": "standard", "deleteSla": 30 } + }, + "examples": { + "readWithLabel": { + "value": "client" + } } }, { @@ -2685,16 +4691,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2703,21 +4711,289 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListConferenceParticipantResponse" + }, + "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" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2729,10 +5005,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListConferenceParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "ListConferenceParticipant" } }, "/v1/Voice/{CallSid}/Events": { @@ -2741,7 +5014,7 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "timestamp", @@ -2750,8 +5023,8 @@ "edge", "name" ], - "pathType": "list", - "parent": "/Voice/{Sid}" + "parent": "/Voice/{Sid}", + "pathType": "list" }, "get": { "description": "Get a list of Call Insight Events for a Call.", @@ -2822,16 +5095,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2840,21 +5115,175 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListEventResponse" + }, + "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 + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2866,10 +5295,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListEvent", - "x-maturity": [ - "Preview" - ] + "operationId": "ListEvent" } }, "/v1/Voice/{CallSid}/Metrics": { @@ -2878,7 +5304,7 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "timestamp", @@ -2887,8 +5313,8 @@ "edge", "direction" ], - "pathType": "list", - "parent": "/Voice/{Sid}" + "parent": "/Voice/{Sid}", + "pathType": "list" }, "get": { "description": "Get a list of Call Metrics for a Call.", @@ -2915,6 +5341,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/metric_enum_twilio_edge" + }, + "examples": { + "readFull": { + "value": "sdk_edge" + } } }, { @@ -2924,6 +5355,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/metric_enum_stream_direction" + }, + "examples": { + "readFull": { + "value": "both" + } } }, { @@ -2968,16 +5404,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2986,21 +5424,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" } }, "title": "ListMetricResponse" + }, + "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 + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3012,10 +5592,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMetric", - "x-maturity": [ - "Preview" - ] + "operationId": "ListMetric" } }, "/v1/Voice/{CallSid}/Summary": { @@ -3024,7 +5601,7 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "call_type", @@ -3032,9 +5609,9 @@ "processing_state", "duration" ], - "pathType": "instance", "parent": "/Voice/{Sid}", - "className": "call_summary" + "className": "call_summary", + "pathType": "instance" }, "get": { "description": "Get a specific Call Summary.", @@ -3070,6 +5647,85 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3081,10 +5737,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSummary", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSummary" } }, "/v1/Video/Rooms/{RoomSid}/Participants/{ParticipantSid}": { @@ -3093,13 +5746,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.", @@ -3132,6 +5785,67 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3143,10 +5857,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchVideoParticipantSummary", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchVideoParticipantSummary" } }, "/v1/Video/Rooms/{RoomSid}/Participants": { @@ -3155,13 +5866,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.", @@ -3220,16 +5931,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3238,21 +5951,107 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListVideoParticipantSummaryResponse" + }, + "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" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3264,10 +6063,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListVideoParticipantSummary", - "x-maturity": [ - "Beta" - ] + "operationId": "ListVideoParticipantSummary" } }, "/v1/Video/Rooms/{RoomSid}": { @@ -3276,13 +6072,12 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "room_sid", "create_time" ], - "pathType": "instance", "dependentProperties": { "participants": { "mapping": { @@ -3290,7 +6085,8 @@ }, "resource_url": "/v1/Video/Rooms/{room_sid}/Participants" } - } + }, + "pathType": "instance" }, "get": { "description": "Get Video Log Analyzer data for a Room.", @@ -3314,6 +6110,78 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3325,10 +6193,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchVideoRoomSummary", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchVideoRoomSummary" } }, "/v1/Video/Rooms": { @@ -3337,13 +6202,12 @@ "url": "https://insights.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "room_sid", "create_time" ], - "pathType": "list", "dependentProperties": { "participants": { "mapping": { @@ -3351,7 +6215,8 @@ }, "resource_url": "/v1/Video/Rooms/{room_sid}/Participants" } - } + }, + "pathType": "list" }, "get": { "description": "Get a list of Programmable Video Rooms.", @@ -3451,16 +6316,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3469,21 +6336,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" } }, "title": "ListVideoRoomSummaryResponse" + }, + "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" + } + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3495,10 +6459,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListVideoRoomSummary", - "x-maturity": [ - "Beta" - ] + "operationId": "ListVideoRoomSummary" } } }, @@ -3542,18 +6503,9 @@ "name": "InsightsV1Setting" } ], - "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." - }, + "security": [ { - "name": "Preview", - "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact https://www.twilio.com/help/contact." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_intelligence_v2.json b/src/services/twilio-api/twilio_intelligence_v2.json index b78c3a10..cb58dd15 100644 --- a/src/services/twilio-api/twilio_intelligence_v2.json +++ b/src/services/twilio-api/twilio_intelligence_v2.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "intelligence.v2.custom_operator": { "type": "object", @@ -822,12 +828,6 @@ "unknown" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -843,7 +843,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -853,13 +853,13 @@ "url": "https://intelligence.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], - "pathType": "list", - "mountName": "custom_operators" + "mountName": "custom_operators", + "pathType": "list" }, "post": { "description": "Create a new Custom Operator for the given Account", @@ -872,6 +872,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.custom_operator" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "My New Operator", + "description": "New Operator", + "author": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "operator_type": "operator-type-name", + "version": 1, + "availability": "public", + "config": { + "configuration": { + "field": "value" + } + }, + "date_created": "2010-08-31T20:36:28Z", + "date_updated": "2010-08-31T20:36:28Z", + "url": "https://intelligence.twilio.com/v2/Operators/Custom/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -880,6 +902,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "Accepted" @@ -891,9 +947,6 @@ } ], "operationId": "CreateCustomOperator", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -918,6 +971,15 @@ "OperatorType", "Config" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "My New Operator", + "Config": "{ \"configuration\" : { \"field\": \"value\"}}", + "OperatorType": "operator-type-name" + } + } } } } @@ -936,6 +998,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/custom_operator_enum_availability" + }, + "examples": { + "readFull": { + "value": "public" + }, + "readEmpty": { + "value": "public" + } } }, { @@ -944,6 +1014,14 @@ "description": "Returns Custom Operators that support the provided language code.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "en" + }, + "readEmpty": { + "value": "en" + } } }, { @@ -988,16 +1066,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1006,21 +1086,104 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListCustomOperatorResponse" + }, + "examples": { + "readFull": { + "value": { + "operators": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "My New Operator", + "description": "New Operator", + "author": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "operator_type": "operator-type-name", + "version": 1, + "availability": "public", + "config": { + "configuration": { + "field": "value" + } + }, + "date_created": "2010-08-31T20:36:28Z", + "date_updated": "2010-08-31T20:36:28Z", + "url": "https://intelligence.twilio.com/v2/Operators/Custom/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://intelligence.twilio.com/v2/Operators/Custom?LanguageCode=en&Availability=public&PageSize=50&Page=0", + "key": "operators", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://intelligence.twilio.com/v2/Operators/Custom?LanguageCode=en&Availability=public&PageSize=50&Page=0" + } + } + }, + "readEmpty": { + "value": { + "operators": [], + "meta": { + "first_page_url": "https://intelligence.twilio.com/v2/Operators/Custom?LanguageCode=en&Availability=public&PageSize=50&Page=0", + "key": "operators", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://intelligence.twilio.com/v2/Operators/Custom?LanguageCode=en&Availability=public&PageSize=50&Page=0" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1032,10 +1195,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCustomOperator", - "x-maturity": [ - "Beta" - ] + "operationId": "ListCustomOperator" } }, "/v2/Operators/Custom/{Sid}": { @@ -1044,13 +1204,13 @@ "url": "https://intelligence.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], - "pathType": "instance", - "mountName": "custom_operators" + "mountName": "custom_operators", + "pathType": "instance" }, "post": { "description": "Update a specific Custom Operator.", @@ -1085,6 +1245,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.custom_operator" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "My New Operator", + "description": "My New Operator", + "author": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "operator_type": "operator-type-name", + "version": 2, + "availability": "public", + "config": { + "configuration": { + "field": "value" + } + }, + "date_created": "2010-08-31T20:36:28Z", + "date_updated": "2010-08-31T20:36:28Z", + "url": "https://intelligence.twilio.com/v2/Operators/Custom/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1093,6 +1275,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "Accepted" @@ -1104,9 +1320,6 @@ } ], "operationId": "UpdateCustomOperator", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1126,6 +1339,14 @@ "FriendlyName", "Config" ] + }, + "examples": { + "update": { + "value": { + "FriendlyName": "My New Operator", + "Config": "{ \"configuration\" : { \"field\": \"value\"}}" + } + } } } } @@ -1160,10 +1381,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCustomOperator", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteCustomOperator" }, "get": { "description": "Fetch a specific Custom Operator.", @@ -1190,6 +1408,28 @@ "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.custom_operator" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "My New Operator", + "description": "New Operator", + "author": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "operator_type": "operator-type-name", + "version": 1, + "availability": "public", + "config": { + "configuration": { + "field": "value" + } + }, + "date_created": "2010-08-31T20:36:28Z", + "date_updated": "2010-08-31T20:36:28Z", + "url": "https://intelligence.twilio.com/v2/Operators/Custom/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -1198,6 +1438,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -1208,10 +1482,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCustomOperator", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchCustomOperator" } }, "/v2/Transcripts/{Sid}/Media": { @@ -1220,15 +1491,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", @@ -1254,6 +1525,11 @@ "description": "Grant access to PII Redacted/Unredacted Media. If redaction is enabled, the default is `true` to access redacted media.", "schema": { "type": "boolean" + }, + "examples": { + "fetchParams": { + "value": "True" + } } } ], @@ -1263,6 +1539,62 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1274,10 +1606,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMedia", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchMedia" } }, "/v2/Operators/{Sid}": { @@ -1286,7 +1615,7 @@ "url": "https://intelligence.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" @@ -1318,6 +1647,64 @@ "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.operator" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "My New Operator", + "description": "New Operator", + "author": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "operator_type": "operator-type-name", + "version": 1, + "availability": "public", + "config": { + "configuration": { + "field": "value" + } + }, + "date_created": "2010-08-31T20:36:28Z", + "date_updated": "2010-08-31T20:36:28Z", + "url": "https://intelligence.twilio.com/v2/Operators/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1329,10 +1716,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchOperator", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchOperator" } }, "/v2/Operators": { @@ -1341,7 +1725,7 @@ "url": "https://intelligence.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" @@ -1361,6 +1745,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/operator_enum_availability" + }, + "examples": { + "readFull": { + "value": "public" + }, + "readEmpty": { + "value": "public" + } } }, { @@ -1369,6 +1761,14 @@ "description": "Returns Operators that support the provided language code.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "en" + }, + "readEmpty": { + "value": "en" + } } }, { @@ -1413,16 +1813,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1431,21 +1833,104 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListOperatorResponse" + }, + "examples": { + "readFull": { + "value": { + "operators": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "My New Operator", + "description": "New Operator", + "author": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "operator_type": "operator-type-name", + "version": 1, + "availability": "public", + "config": { + "configuration": { + "field": "value" + } + }, + "date_created": "2010-08-31T20:36:28Z", + "date_updated": "2010-08-31T20:36:28Z", + "url": "https://intelligence.twilio.com/v2/Operators/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://intelligence.twilio.com/v2/Operators?LanguageCode=en&Availability=public&PageSize=50&Page=0", + "key": "operators", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://intelligence.twilio.com/v2/Operators?LanguageCode=en&Availability=public&PageSize=50&Page=0" + } + } + }, + "readEmpty": { + "value": { + "operators": [], + "meta": { + "first_page_url": "https://intelligence.twilio.com/v2/Operators?LanguageCode=en&Availability=public&PageSize=50&Page=0", + "key": "operators", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://intelligence.twilio.com/v2/Operators?LanguageCode=en&Availability=public&PageSize=50&Page=0" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1457,10 +1942,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListOperator", - "x-maturity": [ - "Beta" - ] + "operationId": "ListOperator" } }, "/v2/Services/{ServiceSid}/Operators/{OperatorSid}": { @@ -1469,14 +1951,14 @@ "url": "https://intelligence.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "service_sid", "operator_sid" ], - "pathType": "instance", - "mountName": "operator_attachment" + "mountName": "operator_attachment", + "pathType": "instance" }, "post": { "description": "Attach an Operator to a Service.", @@ -1515,6 +1997,51 @@ "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.operator_attachment" + }, + "examples": { + "create": { + "value": { + "operator_sid": "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://intelligence.twilio.com/v2/Services/GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Operators/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1526,10 +2053,7 @@ "accountSid_authToken": [] } ], - "operationId": "CreateOperatorAttachment", - "x-maturity": [ - "Beta" - ] + "operationId": "CreateOperatorAttachment" }, "delete": { "description": "Detach an Operator from a Service.", @@ -1572,10 +2096,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteOperatorAttachment", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteOperatorAttachment" } }, "/v2/Services/{ServiceSid}/Operators": { @@ -1584,14 +2105,14 @@ "url": "https://intelligence.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "operator_sids" ], - "pathType": "instance", "mountName": "operator_attachments", - "className": "operator_attachments" + "className": "operator_attachments", + "pathType": "instance" }, "get": { "description": "Retrieve Operators attached to a Service.", @@ -1618,6 +2139,54 @@ "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.operator_attachments" + }, + "examples": { + "fetch": { + "value": { + "service_sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "operator_sids": [ + "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + ], + "url": "https://intelligence.twilio.com/v2/Services/GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Operators" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1629,10 +2198,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchOperatorAttachments", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchOperatorAttachments" } }, "/v2/Transcripts/{TranscriptSid}/OperatorResults": { @@ -1641,13 +2207,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.", @@ -1673,6 +2239,11 @@ "description": "Grant access to PII redacted/unredacted Language Understanding operator. If redaction is enabled, the default is True.", "schema": { "type": "boolean" + }, + "examples": { + "readFull": { + "value": "True" + } } }, { @@ -1717,16 +2288,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "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,25 +2308,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" } }, "title": "ListOperatorResultResponse" - } - } - }, - "description": "OK" + }, + "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": {}, + "text_generation_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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" } }, "security": [ @@ -1761,10 +2418,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListOperatorResult", - "x-maturity": [ - "Beta" - ] + "operationId": "ListOperatorResult" } }, "/v2/Transcripts/{TranscriptSid}/OperatorResults/{OperatorSid}": { @@ -1773,13 +2427,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.", @@ -1817,6 +2471,11 @@ "description": "Grant access to PII redacted/unredacted Language Understanding operator. If redaction is enabled, the default is True.", "schema": { "type": "boolean" + }, + "examples": { + "fetch": { + "value": "False" + } } } ], @@ -1826,6 +2485,65 @@ "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": {}, + "text_generation_results": {}, + "transcript_sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1837,10 +2555,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchOperatorResult", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchOperatorResult" } }, "/v2/OperatorTypes": { @@ -1849,13 +2564,13 @@ "url": "https://intelligence.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], - "pathType": "list", - "mountName": "operator_type" + "mountName": "operator_type", + "pathType": "list" }, "get": { "description": "Retrieves a list of all Operator Types for an Account.", @@ -1905,16 +2620,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1923,21 +2640,106 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListOperatorTypeResponse" + }, + "examples": { + "readFull": { + "value": { + "operator_types": [ + { + "name": "Summarization", + "sid": "EYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Summarize Conversations", + "description": "Summarize Conversations", + "docs_link": "https://www.twilio.com/docs/voice/intelligence/key-concepts#language-operators", + "output_type": "text-generation", + "supported_languages": [ + "en" + ], + "provider": "openai", + "availability": "public", + "configurable": true, + "config_schema": { + "field": "value" + }, + "date_created": "2010-08-31T20:36:28Z", + "date_updated": "2010-08-31T20:36:28Z", + "url": "https://intelligence.twilio.com/v2/OperatorTypes/EYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://intelligence.twilio.com/v2/OperatorTypes?PageSize=50&Page=0", + "key": "operator_types", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://intelligence.twilio.com/v2/OperatorTypes?PageSize=50&Page=0" + } + } + }, + "readEmpty": { + "value": { + "operator_types": [], + "meta": { + "first_page_url": "https://intelligence.twilio.com/v2/OperatorTypes?PageSize=50&Page=0", + "key": "operator_types", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://intelligence.twilio.com/v2/OperatorTypes?PageSize=50&Page=0" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1949,10 +2751,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListOperatorType", - "x-maturity": [ - "Beta" - ] + "operationId": "ListOperatorType" } }, "/v2/OperatorTypes/{Sid}": { @@ -1961,13 +2760,13 @@ "url": "https://intelligence.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], - "pathType": "instance", - "mountName": "operator_type" + "mountName": "operator_type", + "pathType": "instance" }, "get": { "description": "Fetch a specific Operator Type.", @@ -1994,6 +2793,66 @@ "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.operator_type" + }, + "examples": { + "fetch": { + "value": { + "name": "Summarization", + "sid": "EYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Summarize Conversations", + "description": "Summarize Conversations", + "docs_link": "https://www.twilio.com/docs/voice/intelligence/key-concepts#language-operators", + "output_type": "text-generation", + "supported_languages": [ + "en" + ], + "provider": "openai", + "availability": "public", + "configurable": true, + "config_schema": { + "field": "value" + }, + "date_created": "2010-08-31T20:36:28Z", + "date_updated": "2010-08-31T20:36:28Z", + "url": "https://intelligence.twilio.com/v2/OperatorTypes/EYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2005,10 +2864,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchOperatorType", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchOperatorType" } }, "/v2/Operators/PreBuilt/{Sid}": { @@ -2017,13 +2873,13 @@ "url": "https://intelligence.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], - "pathType": "instance", - "mountName": "prebuilt_operators" + "mountName": "prebuilt_operators", + "pathType": "instance" }, "get": { "description": "Fetch a specific Pre-built Operator.", @@ -2050,6 +2906,64 @@ "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.prebuilt_operator" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "My New Operator", + "description": "New Operator", + "author": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "operator_type": "operator-type-name", + "version": 1, + "availability": "public", + "config": { + "configuration": { + "field": "value" + } + }, + "date_created": "2010-08-31T20:36:28Z", + "date_updated": "2010-08-31T20:36:28Z", + "url": "https://intelligence.twilio.com/v2/Operators/PreBuilt/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2061,10 +2975,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchPrebuiltOperator", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchPrebuiltOperator" } }, "/v2/Operators/PreBuilt": { @@ -2073,13 +2984,13 @@ "url": "https://intelligence.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], - "pathType": "list", - "mountName": "prebuilt_operators" + "mountName": "prebuilt_operators", + "pathType": "list" }, "get": { "description": "Retrieves a list of all Pre-built Operators for an account.", @@ -2094,6 +3005,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/prebuilt_operator_enum_availability" + }, + "examples": { + "readFull": { + "value": "public" + }, + "readEmpty": { + "value": "public" + } } }, { @@ -2102,6 +3021,14 @@ "description": "Returns Pre-built Operators that support the provided language code.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "en" + }, + "readEmpty": { + "value": "en" + } } }, { @@ -2146,16 +3073,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2164,21 +3093,104 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListPrebuiltOperatorResponse" + }, + "examples": { + "readFull": { + "value": { + "operators": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "My New Operator", + "description": "New Operator", + "author": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "operator_type": "operator-type-name", + "version": 1, + "availability": "public", + "config": { + "configuration": { + "field": "value" + } + }, + "date_created": "2010-08-31T20:36:28Z", + "date_updated": "2010-08-31T20:36:28Z", + "url": "https://intelligence.twilio.com/v2/Operators/PreBuilt/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://intelligence.twilio.com/v2/Operators/PreBuilt?LanguageCode=en&Availability=public&PageSize=50&Page=0", + "key": "operators", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://intelligence.twilio.com/v2/Operators/PreBuilt?LanguageCode=en&Availability=public&PageSize=50&Page=0" + } + } + }, + "readEmpty": { + "value": { + "operators": [], + "meta": { + "first_page_url": "https://intelligence.twilio.com/v2/Operators/PreBuilt?LanguageCode=en&Availability=public&PageSize=50&Page=0", + "key": "operators", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://intelligence.twilio.com/v2/Operators/PreBuilt?LanguageCode=en&Availability=public&PageSize=50&Page=0" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2190,10 +3202,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListPrebuiltOperator", - "x-maturity": [ - "Beta" - ] + "operationId": "ListPrebuiltOperator" } }, "/v2/Transcripts/{TranscriptSid}/Sentences": { @@ -2202,7 +3211,7 @@ "url": "https://intelligence.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2213,8 +3222,8 @@ "end_time", "confidence" ], - "pathType": "list", - "parent": "/Transcripts/{Sid}" + "parent": "/Transcripts/{Sid}", + "pathType": "list" }, "get": { "description": "Get all Transcript Sentences by TranscriptSid", @@ -2240,6 +3249,11 @@ "description": "Grant access to PII Redacted/Unredacted Sentences. If redaction is enabled, the default is `true` to access redacted sentences.", "schema": { "type": "boolean" + }, + "examples": { + "readParams": { + "value": "True" + } } }, { @@ -2284,16 +3298,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2302,21 +3318,105 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListSentenceResponse" + }, + "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 + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2328,10 +3428,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSentence", - "x-maturity": [ - "Beta" - ] + "operationId": "ListSentence" } }, "/v2/Services": { @@ -2340,7 +3437,7 @@ "url": "https://intelligence.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2363,6 +3460,30 @@ "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", + "read_only_attached_operator_sids": [ + "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "version": 1, + "url": "https://intelligence.twilio.com/v2/Services/GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2371,6 +3492,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "Created" @@ -2382,9 +3537,6 @@ } ], "operationId": "CreateService", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2433,6 +3585,17 @@ "required": [ "UniqueName" ] + }, + "examples": { + "create": { + "value": { + "UniqueName": "something", + "FriendlyName": "some friendly name", + "LanguageCode": "en-US", + "WebhookUrl": "https://www.twilio.com", + "WebhookHttpMethod": "POST" + } + } } } } @@ -2486,16 +3649,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2504,21 +3669,106 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListServiceResponse" + }, + "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", + "read_only_attached_operator_sids": [ + "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2530,10 +3780,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListService", - "x-maturity": [ - "Beta" - ] + "operationId": "ListService" } }, "/v2/Services/{Sid}": { @@ -2542,7 +3789,7 @@ "url": "https://intelligence.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2580,10 +3827,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteService", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteService" }, "get": { "description": "Fetch a specific Service.", @@ -2607,6 +3851,30 @@ "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", + "read_only_attached_operator_sids": [ + "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "version": 1, + "url": "https://intelligence.twilio.com/v2/Services/GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2615,6 +3883,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -2625,10 +3927,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchService", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchService" }, "post": { "description": "Update a specific Service.", @@ -2660,6 +3959,30 @@ "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", + "read_only_attached_operator_sids": [ + "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "version": 2, + "url": "https://intelligence.twilio.com/v2/Services/GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } }, @@ -2668,6 +3991,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -2679,9 +4036,6 @@ } ], "operationId": "UpdateService", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2723,12 +4077,19 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -2738,7 +4099,7 @@ "url": "https://intelligence.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2747,7 +4108,6 @@ "duration", "status" ], - "pathType": "list", "dependentProperties": { "sentences": { "mapping": { @@ -2767,7 +4127,8 @@ }, "resource_url": "/v2/Transcripts/{transcript_sid}/OperatorResults" } - } + }, + "pathType": "list" }, "post": { "description": "Create a new Transcript for the service", @@ -2780,6 +4141,98 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2792,9 +4245,6 @@ } ], "operationId": "CreateTranscript", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2826,6 +4276,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" + } + } } } } @@ -2846,6 +4312,17 @@ "minLength": 34, "maxLength": 34, "pattern": "^GA[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readQuery": { + "value": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -2878,6 +4355,11 @@ "description": "Filter by after DateCreated.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "2019-11-22T23:46:00Z" + } } }, { @@ -2894,6 +4376,11 @@ "description": "Filter by Language Code.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "en-US" + } } }, { @@ -2902,6 +4389,11 @@ "description": "Filter by SourceSid.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -2946,16 +4438,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "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,21 +4458,143 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListTranscriptResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2990,10 +4606,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTranscript", - "x-maturity": [ - "Beta" - ] + "operationId": "ListTranscript" } }, "/v2/Transcripts/{Sid}": { @@ -3002,7 +4615,7 @@ "url": "https://intelligence.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3011,7 +4624,6 @@ "duration", "status" ], - "pathType": "instance", "dependentProperties": { "sentences": { "mapping": { @@ -3031,7 +4643,8 @@ }, "resource_url": "/v2/Transcripts/{transcript_sid}/OperatorResults" } - } + }, + "pathType": "instance" }, "get": { "description": "Fetch a specific Transcript.", @@ -3058,6 +4671,67 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3069,10 +4743,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTranscript", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchTranscript" }, "delete": { "description": "Delete a specific Transcript.", @@ -3103,10 +4774,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteTranscript", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteTranscript" } } }, @@ -3150,10 +4818,9 @@ "name": "IntelligenceV2Transcript" } ], - "x-maturity": [ + "security": [ { - "name": "Beta", - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_ip_messaging_v1.json b/src/services/twilio-api/twilio_ip_messaging_v1.json index 000f64d1..dd6d2790 100644 --- a/src/services/twilio-api/twilio_ip_messaging_v1.json +++ b/src/services/twilio-api/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.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -690,14 +690,13 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "friendly_name" ], - "pathType": "instance", "dependentProperties": { "members": { "mapping": { @@ -721,7 +720,8 @@ "resource_url": "/v1/Services/{service_sid}/Channels/{channel_sid}/Invites" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -757,6 +757,67 @@ "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 + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -768,10 +829,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchChannel", - "x-maturity": [ - "GA" - ] + "operationId": "FetchChannel" }, "delete": { "description": "", @@ -811,10 +869,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteChannel", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteChannel" }, "post": { "description": "", @@ -850,6 +905,67 @@ "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 + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -862,9 +978,6 @@ } ], "operationId": "UpdateChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -885,12 +998,19 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "Type": "channel", + "FriendlyName": "friendly_name", + "UniqueName": "unique_name", + "Attributes": "{ \"foo\": \"bar\" }" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -900,14 +1020,13 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "friendly_name" ], - "pathType": "list", "dependentProperties": { "members": { "mapping": { @@ -931,7 +1050,8 @@ "resource_url": "/v1/Services/{service_sid}/Channels/{channel_sid}/Invites" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -958,6 +1078,67 @@ "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 + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -970,9 +1151,6 @@ } ], "operationId": "CreateChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -998,12 +1176,19 @@ "description": "" } } + }, + "examples": { + "create": { + "value": { + "Type": "public", + "FriendlyName": "friendly_name", + "UniqueName": "unique_name", + "Attributes": "{ \"foo\": \"bar\" }" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -1078,16 +1263,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1096,21 +1283,107 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListChannelResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1122,10 +1395,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListChannel" } }, "/v1/Credentials": { @@ -1134,7 +1404,7 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -1191,16 +1461,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1209,21 +1481,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" } }, "title": "ListCredentialResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1235,10 +1582,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCredential", - "x-maturity": [ - "GA" - ] + "operationId": "ListCredential" }, "post": { "description": "", @@ -1251,6 +1595,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1263,9 +1657,6 @@ } ], "operationId": "CreateCredential", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1306,6 +1697,13 @@ "required": [ "Type" ] + }, + "examples": { + "create": { + "value": { + "Type": "apn" + } + } } } } @@ -1318,7 +1716,7 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -1352,6 +1750,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1363,10 +1811,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCredential", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCredential" }, "post": { "description": "", @@ -1393,6 +1838,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1405,9 +1900,6 @@ } ], "operationId": "UpdateCredential", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1440,12 +1932,16 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "Test slow create" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -1477,10 +1973,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCredential", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCredential" } }, "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}": { @@ -1489,15 +1982,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": "", @@ -1545,6 +2038,58 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1556,10 +2101,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInvite", - "x-maturity": [ - "GA" - ] + "operationId": "FetchInvite" }, "delete": { "description": "", @@ -1611,10 +2153,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteInvite", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteInvite" } }, "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites": { @@ -1623,15 +2162,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": "", @@ -1667,6 +2206,58 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1679,9 +2270,6 @@ } ], "operationId": "CreateInvite", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1704,6 +2292,14 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "identity", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -1745,6 +2341,18 @@ "items": { "type": "string" } + }, + "examples": { + "readEmpty": { + "value": [ + "identity" + ] + }, + "readFull": { + "value": [ + "identity" + ] + } } }, { @@ -1789,16 +2397,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1807,37 +2417,111 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListInviteResponse" + }, + "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" - ] - } + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListInvite" + } }, "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}": { "servers": [ @@ -1845,15 +2529,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": "", @@ -1901,6 +2585,59 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1912,10 +2649,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMember", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMember" }, "delete": { "description": "", @@ -1967,10 +2701,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMember", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteMember" }, "post": { "description": "", @@ -2018,6 +2749,74 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2030,9 +2829,6 @@ } ], "operationId": "UpdateMember", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2053,12 +2849,21 @@ "description": "" } } + }, + "examples": { + "updateRoleSid": { + "value": { + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "updateLastConsumedMessageIndex": { + "value": { + "LastConsumedMessageIndex": 666 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -2068,15 +2873,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": "", @@ -2112,6 +2917,59 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2124,9 +2982,6 @@ } ], "operationId": "CreateMember", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2149,6 +3004,13 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "Twilio" + } + } } } } @@ -2234,16 +3096,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2252,21 +3116,99 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListMemberResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2278,10 +3220,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMember", - "x-maturity": [ - "GA" - ] + "operationId": "ListMember" } }, "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}": { @@ -2290,7 +3229,7 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2298,8 +3237,8 @@ "to", "date_created" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -2350,6 +3289,61 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2361,10 +3355,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMessage", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMessage" }, "delete": { "description": "", @@ -2419,10 +3410,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMessage", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteMessage" }, "post": { "description": "", @@ -2473,6 +3461,61 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2485,9 +3528,6 @@ } ], "operationId": "UpdateMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2504,12 +3544,16 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "Body": "Hello" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -2519,7 +3563,7 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2527,8 +3571,8 @@ "to", "date_created" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -2567,6 +3611,78 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2579,9 +3695,6 @@ } ], "operationId": "CreateMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2605,6 +3718,19 @@ "required": [ "Body" ] + }, + "examples": { + "create": { + "value": { + "Body": "Hello" + } + }, + "createWithAttributes": { + "value": { + "Body": "Hello", + "Attributes": "{\"test\": \"test\"}" + } + } } } } @@ -2691,16 +3817,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2709,21 +3837,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" } }, "title": "ListMessageResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2735,10 +3943,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMessage", - "x-maturity": [ - "GA" - ] + "operationId": "ListMessage" } }, "/v1/Services/{ServiceSid}/Roles/{Sid}": { @@ -2747,15 +3952,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": "", @@ -2794,6 +3999,62 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2805,10 +4066,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRole", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRole" }, "delete": { "description": "", @@ -2851,10 +4109,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRole", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRole" }, "post": { "description": "", @@ -2893,6 +4148,62 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2905,9 +4216,6 @@ } ], "operationId": "UpdateRole", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2926,6 +4234,13 @@ "required": [ "Permission" ] + }, + "examples": { + "update": { + "value": { + "Permission": "sendMessage" + } + } } } } @@ -2938,15 +4253,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": "", @@ -2973,6 +4288,62 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2985,9 +4356,6 @@ } ], "operationId": "CreateRole", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3017,6 +4385,15 @@ "Type", "Permission" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "Type": "channel", + "Permission": "sendMessage" + } + } } } } @@ -3082,16 +4459,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "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,21 +4479,102 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListRoleResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3126,10 +4586,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRole", - "x-maturity": [ - "GA" - ] + "operationId": "ListRole" } }, "/v1/Services/{Sid}": { @@ -3138,14 +4595,13 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { "channels": { "mapping": { @@ -3165,7 +4621,8 @@ }, "resource_url": "/v1/Services/{service_sid}/Users" } - } + }, + "pathType": "instance" }, "get": { "description": "", @@ -3192,6 +4649,78 @@ "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": {} + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3203,10 +4732,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchService", - "x-maturity": [ - "GA" - ] + "operationId": "FetchService" }, "delete": { "description": "", @@ -3237,10 +4763,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteService", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteService" }, "post": { "description": "", @@ -3267,6 +4790,176 @@ "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" + } + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3279,9 +4972,6 @@ } ], "operationId": "UpdateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3621,12 +5311,87 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -3636,14 +5401,13 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { "channels": { "mapping": { @@ -3663,7 +5427,8 @@ }, "resource_url": "/v1/Services/{service_sid}/Users" } - } + }, + "pathType": "list" }, "post": { "description": "", @@ -3676,6 +5441,78 @@ "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": {} + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3688,9 +5525,6 @@ } ], "operationId": "CreateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3706,6 +5540,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } @@ -3759,16 +5600,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3777,21 +5620,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" } }, "title": "ListServiceResponse" + }, + "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": {} + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3803,10 +5743,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListService", - "x-maturity": [ - "GA" - ] + "operationId": "ListService" } }, "/v1/Services/{ServiceSid}/Users/{Sid}": { @@ -3815,14 +5752,13 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { "user_channels": { "mapping": { @@ -3832,7 +5768,8 @@ "resource_url": "/v1/Services/{service_sid}/Users/{user_sid}/Channels" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -3868,6 +5805,64 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3879,10 +5874,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUser", - "x-maturity": [ - "GA" - ] + "operationId": "FetchUser" }, "delete": { "description": "", @@ -3922,10 +5914,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUser", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteUser" }, "post": { "description": "", @@ -3961,6 +5950,64 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3973,9 +6020,6 @@ } ], "operationId": "UpdateUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3999,12 +6043,18 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Attributes": "{\"test\":\"test\"}", + "FriendlyName": "friendly_name" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -4014,14 +6064,13 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { "user_channels": { "mapping": { @@ -4031,7 +6080,8 @@ "resource_url": "/v1/Services/{service_sid}/Users/{user_sid}/Channels" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -4058,6 +6108,64 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4070,9 +6178,6 @@ } ], "operationId": "CreateUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4103,6 +6208,16 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "jing", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Attributes": "{\"test\":\"test\"}", + "FriendlyName": "friendly_name" + } + } } } } @@ -4168,16 +6283,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4186,21 +6303,104 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListUserResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4212,10 +6412,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUser", - "x-maturity": [ - "GA" - ] + "operationId": "ListUser" } }, "/v1/Services/{ServiceSid}/Users/{UserSid}/Channels": { @@ -4224,15 +6421,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": "", @@ -4303,16 +6500,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4321,21 +6520,99 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListUserChannelResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4347,10 +6624,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUserChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListUserChannel" } } }, @@ -4388,10 +6662,9 @@ "name": "IpMessagingV1UserChannel" } ], - "x-maturity": [ + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_ip_messaging_v2.json b/src/services/twilio-api/twilio_ip_messaging_v2.json index 570eaff0..89cce186 100644 --- a/src/services/twilio-api/twilio_ip_messaging_v2.json +++ b/src/services/twilio-api/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.56.1" + "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": "", @@ -1092,16 +1092,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1110,21 +1112,107 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListBindingResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1136,10 +1224,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListBinding", - "x-maturity": [ - "GA" - ] + "operationId": "ListBinding" } }, "/v2/Services/{ServiceSid}/Bindings/{Sid}": { @@ -1148,15 +1233,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": "", @@ -1195,6 +1280,67 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1206,10 +1352,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchBinding", - "x-maturity": [ - "GA" - ] + "operationId": "FetchBinding" }, "delete": { "description": "", @@ -1252,10 +1395,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteBinding", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteBinding" } }, "/v2/Services/{ServiceSid}/Channels/{Sid}": { @@ -1264,14 +1404,13 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "friendly_name" ], - "pathType": "instance", "dependentProperties": { "members": { "mapping": { @@ -1302,7 +1441,8 @@ "resource_url": "/v2/Services/{service_sid}/Channels/{channel_sid}/Webhooks" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -1338,6 +1478,68 @@ "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 + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1349,10 +1551,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchChannel", - "x-maturity": [ - "GA" - ] + "operationId": "FetchChannel" }, "delete": { "description": "", @@ -1401,10 +1600,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteChannel", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteChannel" }, "post": { "description": "", @@ -1449,6 +1645,68 @@ "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 + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1461,9 +1719,6 @@ } ], "operationId": "UpdateChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1498,12 +1753,22 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -1513,14 +1778,13 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "friendly_name" ], - "pathType": "list", "dependentProperties": { "members": { "mapping": { @@ -1551,7 +1815,8 @@ "resource_url": "/v2/Services/{service_sid}/Channels/{channel_sid}/Webhooks" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -1587,6 +1852,68 @@ "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 + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1599,9 +1926,6 @@ } ], "operationId": "CreateChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1641,12 +1965,22 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -1721,16 +2055,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1739,21 +2075,108 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListChannelResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1765,10 +2188,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListChannel" } }, "/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks": { @@ -1777,14 +2197,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": "", @@ -1855,16 +2275,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1873,21 +2295,137 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListChannelWebhookResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1899,10 +2437,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListChannelWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "ListChannelWebhook" }, "post": { "description": "", @@ -1938,6 +2473,65 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1950,9 +2544,6 @@ } ], "operationId": "CreateChannelWebhook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2003,6 +2594,20 @@ "required": [ "Type" ] + }, + "examples": { + "create": { + "value": { + "Type": "webhook", + "Configuration.Url": "dummy", + "Configuration.Method": "GET", + "Configuration.Filters": [ + "onMessageSent", + "onChannelDestroyed" + ], + "Configuration.RetryCount": 2 + } + } } } } @@ -2015,14 +2620,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": "", @@ -2070,6 +2675,59 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2081,10 +2739,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchChannelWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "FetchChannelWebhook" }, "post": { "description": "", @@ -2132,6 +2787,65 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2144,9 +2858,6 @@ } ], "operationId": "UpdateChannelWebhook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2189,12 +2900,22 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "Configuration.Url": "dummy", + "Configuration.Method": "POST", + "Configuration.Triggers": [ + "keyword1", + "keyword2" + ], + "Configuration.RetryCount": 5 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -2247,10 +2968,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteChannelWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteChannelWebhook" } }, "/v2/Credentials": { @@ -2259,7 +2977,7 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2316,16 +3034,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2334,36 +3054,108 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListCredentialResponse" - } - } - }, - "description": "OK" - } + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } }, "security": [ { "accountSid_authToken": [] } ], - "operationId": "ListCredential", - "x-maturity": [ - "GA" - ] + "operationId": "ListCredential" }, "post": { "description": "", @@ -2376,6 +3168,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2388,9 +3230,6 @@ } ], "operationId": "CreateCredential", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2431,6 +3270,13 @@ "required": [ "Type" ] + }, + "examples": { + "create": { + "value": { + "Type": "apn" + } + } } } } @@ -2443,7 +3289,7 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2477,6 +3323,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2488,10 +3384,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCredential", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCredential" }, "post": { "description": "", @@ -2518,6 +3411,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2530,9 +3473,6 @@ } ], "operationId": "UpdateCredential", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2565,12 +3505,16 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "Test slow create" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -2602,10 +3546,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCredential", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCredential" } }, "/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}": { @@ -2614,15 +3555,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": "", @@ -2670,6 +3611,58 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2681,10 +3674,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInvite", - "x-maturity": [ - "GA" - ] + "operationId": "FetchInvite" }, "delete": { "description": "", @@ -2736,10 +3726,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteInvite", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteInvite" } }, "/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites": { @@ -2748,15 +3735,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": "", @@ -2792,6 +3779,58 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2804,9 +3843,6 @@ } ], "operationId": "CreateInvite", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2829,6 +3865,14 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "identity", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -2870,6 +3914,18 @@ "items": { "type": "string" } + }, + "examples": { + "readEmpty": { + "value": [ + "identity" + ] + }, + "readFull": { + "value": [ + "identity" + ] + } } }, { @@ -2914,16 +3970,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2932,21 +3990,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" } }, "title": "ListInviteResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2958,10 +4093,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListInvite", - "x-maturity": [ - "GA" - ] + "operationId": "ListInvite" } }, "/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}": { @@ -2970,15 +4102,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": "", @@ -3023,6 +4155,60 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3034,10 +4220,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMember", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMember" }, "delete": { "description": "", @@ -3095,10 +4278,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMember", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteMember" }, "post": { "description": "", @@ -3152,6 +4332,60 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3164,9 +4398,6 @@ } ], "operationId": "UpdateMember", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3206,12 +4437,21 @@ "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": "{}" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -3221,15 +4461,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": "", @@ -3274,6 +4514,60 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3286,9 +4580,6 @@ } ], "operationId": "CreateMember", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3335,6 +4626,14 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "Twilio", + "Attributes": "{}" + } + } } } } @@ -3420,16 +4719,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3438,21 +4739,100 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListMemberResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3464,10 +4844,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMember", - "x-maturity": [ - "GA" - ] + "operationId": "ListMember" } }, "/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}": { @@ -3476,7 +4853,7 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3484,8 +4861,8 @@ "to", "date_created" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -3533,6 +4910,89 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3544,10 +5004,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMessage", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMessage" }, "delete": { "description": "", @@ -3608,10 +5065,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMessage", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteMessage" }, "post": { "description": "", @@ -3668,6 +5122,64 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3680,9 +5192,6 @@ } ], "operationId": "UpdateMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3717,12 +5226,21 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -3732,7 +5250,7 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3740,8 +5258,8 @@ "to", "date_created" ], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Channels/{Sid}" + "parent": "/Services/{ServiceSid}/Channels/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -3786,6 +5304,109 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3798,9 +5419,6 @@ } ], "operationId": "CreateMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3842,12 +5460,30 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -3928,16 +5564,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3946,21 +5584,127 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListMessageResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3972,10 +5716,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMessage", - "x-maturity": [ - "GA" - ] + "operationId": "ListMessage" } }, "/v2/Services/{ServiceSid}/Roles/{Sid}": { @@ -3984,15 +5725,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": "", @@ -4031,6 +5772,62 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4042,10 +5839,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRole", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRole" }, "delete": { "description": "", @@ -4088,10 +5882,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRole", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRole" }, "post": { "description": "", @@ -4130,6 +5921,62 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4142,9 +5989,6 @@ } ], "operationId": "UpdateRole", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4163,6 +6007,13 @@ "required": [ "Permission" ] + }, + "examples": { + "update": { + "value": { + "Permission": "sendMessage" + } + } } } } @@ -4175,15 +6026,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": "", @@ -4210,6 +6061,62 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4222,9 +6129,6 @@ } ], "operationId": "CreateRole", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4254,6 +6158,15 @@ "Type", "Permission" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "Type": "channel", + "Permission": "sendMessage" + } + } } } } @@ -4319,16 +6232,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4337,21 +6252,102 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListRoleResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4363,10 +6359,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRole", - "x-maturity": [ - "GA" - ] + "operationId": "ListRole" } }, "/v2/Services/{Sid}": { @@ -4375,14 +6368,13 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { "channels": { "mapping": { @@ -4408,7 +6400,8 @@ }, "resource_url": "/v2/Services/{service_sid}/Bindings" } - } + }, + "pathType": "instance" }, "get": { "description": "", @@ -4435,6 +6428,84 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4446,10 +6517,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchService", - "x-maturity": [ - "GA" - ] + "operationId": "FetchService" }, "delete": { "description": "", @@ -4480,10 +6548,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteService", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteService" }, "post": { "description": "", @@ -4510,6 +6575,103 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4522,9 +6684,6 @@ } ], "operationId": "UpdateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4676,12 +6835,44 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -4691,14 +6882,13 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { "channels": { "mapping": { @@ -4724,7 +6914,8 @@ }, "resource_url": "/v2/Services/{service_sid}/Bindings" } - } + }, + "pathType": "list" }, "post": { "description": "", @@ -4736,7 +6927,85 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ip_messaging.v2.service" + "$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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4749,9 +7018,6 @@ } ], "operationId": "CreateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4767,6 +7033,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } @@ -4820,16 +7093,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4838,21 +7113,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" } }, "title": "ListServiceResponse" + }, + "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" + } + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4864,10 +7242,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListService", - "x-maturity": [ - "GA" - ] + "operationId": "ListService" } }, "/v2/Services/{ServiceSid}/Users/{Sid}": { @@ -4876,7 +7251,7 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -4884,7 +7259,6 @@ "identity", "date_created" ], - "pathType": "instance", "dependentProperties": { "user_channels": { "mapping": { @@ -4901,7 +7275,8 @@ "resource_url": "/v2/Services/{service_sid}/Users/{user_sid}/Bindings" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -4937,6 +7312,65 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4948,10 +7382,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUser", - "x-maturity": [ - "GA" - ] + "operationId": "FetchUser" }, "delete": { "description": "", @@ -4991,10 +7422,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUser", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteUser" }, "post": { "description": "", @@ -5039,6 +7467,65 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5051,9 +7538,6 @@ } ], "operationId": "UpdateUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5077,12 +7561,18 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Attributes": "{\"test\":\"test\"}", + "FriendlyName": "friendly_name" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -5092,7 +7582,7 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -5100,7 +7590,6 @@ "identity", "date_created" ], - "pathType": "list", "dependentProperties": { "user_channels": { "mapping": { @@ -5117,7 +7606,8 @@ "resource_url": "/v2/Services/{service_sid}/Users/{user_sid}/Bindings" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -5153,6 +7643,65 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5165,9 +7714,6 @@ } ], "operationId": "CreateUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5198,6 +7744,16 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "jing", + "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Attributes": "{\"test\":\"test\"}", + "FriendlyName": "friendly_name" + } + } } } } @@ -5263,16 +7819,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5281,21 +7839,105 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListUserResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5307,10 +7949,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUser", - "x-maturity": [ - "GA" - ] + "operationId": "ListUser" } }, "/v2/Services/{ServiceSid}/Users/{UserSid}/Bindings": { @@ -5319,7 +7958,7 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -5327,9 +7966,9 @@ "identity", "binding_type" ], - "pathType": "list", "parent": "/Services/{ServiceSid}/Users/{Sid}", - "mountName": "user_bindings" + "mountName": "user_bindings", + "pathType": "list" }, "get": { "description": "", @@ -5412,16 +8051,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5430,21 +8071,105 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListUserBindingResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5456,10 +8181,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUserBinding", - "x-maturity": [ - "GA" - ] + "operationId": "ListUserBinding" } }, "/v2/Services/{ServiceSid}/Users/{UserSid}/Bindings/{Sid}": { @@ -5468,7 +8190,7 @@ "url": "https://ip-messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -5476,9 +8198,9 @@ "identity", "binding_type" ], - "pathType": "instance", "parent": "/Services/{ServiceSid}/Users/{Sid}", - "mountName": "user_bindings" + "mountName": "user_bindings", + "pathType": "instance" }, "get": { "description": "", @@ -5526,6 +8248,65 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5537,10 +8318,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUserBinding", - "x-maturity": [ - "GA" - ] + "operationId": "FetchUserBinding" }, "delete": { "description": "", @@ -5592,10 +8370,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUserBinding", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteUserBinding" } }, "/v2/Services/{ServiceSid}/Users/{UserSid}/Channels": { @@ -5604,15 +8379,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": "", @@ -5683,16 +8458,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5701,21 +8478,102 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListUserChannelResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5727,10 +8585,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUserChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListUserChannel" } }, "/v2/Services/{ServiceSid}/Users/{UserSid}/Channels/{ChannelSid}": { @@ -5739,15 +8594,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": "", @@ -5792,6 +8647,62 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5803,10 +8714,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUserChannel", - "x-maturity": [ - "GA" - ] + "operationId": "FetchUserChannel" }, "delete": { "description": "", @@ -5855,10 +8763,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUserChannel", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteUserChannel" }, "post": { "description": "", @@ -5903,6 +8808,80 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5915,9 +8894,6 @@ } ], "operationId": "UpdateUserChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5941,12 +8917,21 @@ "description": "" } } + }, + "examples": { + "updateNotificationLevel": { + "value": { + "NotificationLevel": "muted" + } + }, + "updateLastConsumedMessageIndex": { + "value": { + "LastConsumedMessageIndex": 10 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } } @@ -5994,10 +8979,9 @@ "name": "IpMessagingV2Webhook" } ], - "x-maturity": [ + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_lookups_v1.json b/src/services/twilio-api/twilio_lookups_v1.json index f8bafb6f..c6d8b5c8 100644 --- a/src/services/twilio-api/twilio_lookups_v1.json +++ b/src/services/twilio-api/twilio_lookups_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "lookups.v1.phone_number": { "type": "object", @@ -78,12 +84,6 @@ "voip" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -99,7 +99,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -152,6 +152,26 @@ "handling": "standard", "deleteSla": 30 } + }, + "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" + } } }, { @@ -163,6 +183,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" + ] + } } }, { @@ -180,6 +241,23 @@ "handling": "standard", "deleteSla": 30 } + }, + "examples": { + "fetchAddonsWhitepagesPro": { + "value": [ + "whitepages_pro_caller_id" + ] + }, + "fetchAddonsNomorobo": { + "value": [ + "nomorobo_spamscore" + ] + }, + "fetchAddonsPayfone": { + "value": [ + "payfone_tcpa_compliance" + ] + } } }, { @@ -198,6 +276,267 @@ "application/json": { "schema": { "$ref": "#/components/schemas/lookups.v1.phone_number" + }, + "examples": { + "fetch": { + "value": { + "caller_name": null, + "carrier": 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", + "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", + "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, + "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" + }, + "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, + "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 + }, + "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 + }, + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -209,10 +548,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchPhoneNumber", - "x-maturity": [ - "GA" - ] + "operationId": "FetchPhoneNumber" } } }, @@ -226,10 +562,9 @@ "name": "LookupsV1PhoneNumber" } ], - "x-maturity": [ + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_lookups_v2.json b/src/services/twilio-api/twilio_lookups_v2.json index 279f3cfd..1ed7020f 100644 --- a/src/services/twilio-api/twilio_lookups_v2.json +++ b/src/services/twilio-api/twilio_lookups_v2.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "lookups.v2.phone_number": { "type": "object", @@ -130,12 +136,6 @@ "NOT_A_NUMBER" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -151,7 +151,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -199,6 +199,56 @@ "description": "A comma-separated list of fields to return. Possible values are validation, caller_name, sim_swap, call_forwarding, line_status, line_type_intelligence, identity_match, reassigned_number, sms_pumping_risk, phone_number_quality_score, pre_fill.", "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" + }, + "fetchLineStatusActive": { + "value": "line_status" + }, + "fetchLineStatusInactive": { + "value": "line_status" + }, + "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" + }, + "fetchPhoneNumberQualityScore": { + "value": "phone_number_quality_score" + }, + "fetchPreFill": { + "value": "pre_fill" + } } }, { @@ -221,6 +271,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" + } } }, { @@ -229,6 +284,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" + } } }, { @@ -237,6 +297,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" + } } }, { @@ -245,6 +310,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" + } } }, { @@ -253,6 +323,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" + } } }, { @@ -261,6 +336,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" + } } }, { @@ -269,6 +349,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" + } } }, { @@ -278,6 +363,11 @@ "schema": { "type": "string", "format": "iso-country-code" + }, + "examples": { + "fetchIdentityMatch": { + "value": "US" + } } }, { @@ -292,6 +382,11 @@ "handling": "sensitive", "deleteSla": 30 } + }, + "examples": { + "fetchIdentityMatch": { + "value": "YZ3456883" + } } }, { @@ -306,6 +401,11 @@ "handling": "sensitive", "deleteSla": 30 } + }, + "examples": { + "fetchIdentityMatch": { + "value": "19901214" + } } }, { @@ -314,6 +414,17 @@ "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" + } } }, { @@ -322,6 +433,11 @@ "description": "The unique identifier associated with a verification process through verify API. This query parameter is only used (optionally) for pre_fill package requests.", "schema": { "type": "string" + }, + "examples": { + "fetchPreFill": { + "value": "VEb0ffb48bee328cf2d3c4020072cdfxxx" + } } } ], @@ -331,6 +447,536 @@ "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, + "line_status": null, + "line_type_intelligence": null, + "identity_match": null, + "reassigned_number": null, + "sms_pumping_risk": null, + "phone_number_quality_score": null, + "pre_fill": 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, + "line_status": null, + "line_type_intelligence": null, + "identity_match": null, + "reassigned_number": null, + "sms_pumping_risk": null, + "phone_number_quality_score": null, + "pre_fill": 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, + "line_status": null, + "line_type_intelligence": null, + "identity_match": null, + "reassigned_number": null, + "sms_pumping_risk": null, + "phone_number_quality_score": null, + "pre_fill": 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": "PT48H", + "swapped_in_period": true + }, + "carrier_name": "Vodafone UK", + "mobile_country_code": "276", + "mobile_network_code": "02", + "error_code": null + }, + "call_forwarding": null, + "line_status": null, + "line_type_intelligence": null, + "identity_match": null, + "reassigned_number": null, + "sms_pumping_risk": null, + "phone_number_quality_score": null, + "pre_fill": 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, + "line_status": null, + "line_type_intelligence": null, + "identity_match": null, + "reassigned_number": null, + "sms_pumping_risk": null, + "phone_number_quality_score": null, + "pre_fill": 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, + "line_status": null, + "line_type_intelligence": null, + "identity_match": null, + "reassigned_number": null, + "sms_pumping_risk": null, + "phone_number_quality_score": null, + "pre_fill": 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, + "error_code": null + }, + "line_status": null, + "line_type_intelligence": null, + "identity_match": null, + "reassigned_number": null, + "sms_pumping_risk": null, + "phone_number_quality_score": null, + "pre_fill": 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, + "error_code": null + }, + "line_status": null, + "line_type_intelligence": null, + "identity_match": null, + "reassigned_number": null, + "sms_pumping_risk": null, + "phone_number_quality_score": null, + "pre_fill": null, + "url": "https://lookups.twilio.com/v2/PhoneNumbers/+447772000001" + } + }, + "fetchLineStatusActive": { + "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, + "line_status": { + "status": "active", + "error_code": null + }, + "line_type_intelligence": null, + "identity_match": null, + "reassigned_number": null, + "sms_pumping_risk": null, + "phone_number_quality_score": null, + "pre_fill": null, + "url": "https://lookups.twilio.com/v2/PhoneNumbers/+447772000001" + } + }, + "fetchLineStatusInactive": { + "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, + "line_status": { + "status": "inactive", + "error_code": null + }, + "line_type_intelligence": null, + "identity_match": null, + "reassigned_number": null, + "sms_pumping_risk": null, + "phone_number_quality_score": null, + "pre_fill": 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, + "line_status": 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, + "phone_number_quality_score": null, + "pre_fill": 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, + "line_status": 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, + "phone_number_quality_score": null, + "pre_fill": 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, + "line_status": null, + "line_type_intelligence": null, + "identity_match": null, + "reassigned_number": null, + "sms_pumping_risk": { + "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 + }, + "phone_number_quality_score": null, + "pre_fill": 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, + "line_status": 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, + "phone_number_quality_score": null, + "pre_fill": 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, + "line_status": 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, + "phone_number_quality_score": null, + "pre_fill": 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, + "line_status": 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, + "phone_number_quality_score": null, + "pre_fill": null, + "url": "https://lookups.twilio.com/v2/PhoneNumbers/+14159929960" + } + }, + "fetchPhoneNumberQualityScore": { + "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, + "line_status": null, + "line_type_intelligence": null, + "identity_match": null, + "reassigned_number": null, + "sms_pumping_risk": null, + "phone_number_quality_score": { + "carrier_risk_score": 17, + "carrier_risk_category": "low", + "disposable_phone_risk_score": 13, + "disposable_phone_risk_category": "low", + "quality_score": 0, + "quality_category": "low", + "velocity_risk_score": 0, + "velocity_risk_category": "low", + "error_code": null + }, + "pre_fill": null, + "url": "https://lookups.twilio.com/v2/PhoneNumbers/+14159929960" + } + }, + "fetchPreFill": { + "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, + "line_status": null, + "line_type_intelligence": null, + "identity_match": null, + "reassigned_number": null, + "sms_pumping_risk": null, + "phone_number_quality_score": null, + "pre_fill": { + "first_name": "John", + "last_name": "Doe", + "address_line": "321 Main Street", + "country_code": "US", + "state": "WA", + "postal_code": "98117", + "error_code": null + }, + "url": "https://lookups.twilio.com/v2/PhoneNumbers/+14159929960" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -342,10 +988,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchPhoneNumber", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchPhoneNumber" } } }, @@ -359,10 +1002,9 @@ "name": "LookupsV2PhoneNumber" } ], - "x-maturity": [ + "security": [ { - "name": "Beta", - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_marketplace_v1.json b/src/services/twilio-api/twilio_marketplace_v1.json new file mode 100644 index 00000000..acb2f924 --- /dev/null +++ b/src/services/twilio-api/twilio_marketplace_v1.json @@ -0,0 +1,2407 @@ +{ + "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, + "schemas": { + "info": {}, + "marketplace.available_add_on": { + "type": "object", + "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XB[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that we created to identify the AvailableAddOn resource." + }, + "friendly_name": { + "type": "string", + "nullable": true, + "description": "The string that you assigned to describe the resource." + }, + "description": { + "type": "string", + "nullable": true, + "description": "A short description of the Add-on's functionality." + }, + "pricing_type": { + "type": "string", + "nullable": true, + "description": "How customers are charged for using this Add-on." + }, + "configuration_schema": { + "nullable": true, + "description": "The JSON object with the configuration that must be provided when installing a given Add-on." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the resource." + }, + "links": { + "type": "object", + "format": "uri-map", + "nullable": true, + "description": "The URLs of related resources." + } + } + }, + "marketplace.available_add_on.available_add_on_extension": { + "type": "object", + "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XF[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that we created to identify the AvailableAddOnExtension resource." + }, + "available_add_on_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XB[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the AvailableAddOn resource to which this extension applies." + }, + "friendly_name": { + "type": "string", + "nullable": true, + "description": "The string that you assigned to describe the resource." + }, + "product_name": { + "type": "string", + "nullable": true, + "description": "The name of the Product this Extension is used within." + }, + "unique_name": { + "type": "string", + "nullable": true, + "description": "An application-defined string that uniquely identifies the resource." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the resource." + } + } + }, + "marketplace.installed_add_on": { + "type": "object", + "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XE[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that we created to identify the InstalledAddOn resource. This Sid can also be found in the Console on that specific Add-ons page as the 'Available Add-on Sid'." + }, + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the InstalledAddOn resource." + }, + "friendly_name": { + "type": "string", + "nullable": true, + "description": "The string that you assigned to describe the resource." + }, + "description": { + "type": "string", + "nullable": true, + "description": "A short description of the Add-on's functionality." + }, + "configuration": { + "nullable": true, + "description": "The JSON object that represents the current configuration of installed Add-on." + }, + "unique_name": { + "type": "string", + "nullable": true, + "description": "An application-defined string that uniquely identifies the resource." + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." + }, + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the resource." + }, + "links": { + "type": "object", + "format": "uri-map", + "nullable": true, + "description": "The URLs of related resources." + } + } + }, + "marketplace.installed_add_on.billing_usage_response": { + "type": "object", + "properties": { + "billable_items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "quantity": { + "type": "number", + "description": "" + }, + "sid": { + "type": "string", + "description": "" + }, + "submitted": { + "type": "boolean", + "description": "Whether this billable item was successfully submitted for billing." + } + } + } + }, + "total_submitted": { + "type": "number", + "description": "Represents the total quantity submitted." + } + } + }, + "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." + } + } + }, + "marketplace.installed_add_on.installed_add_on_usage": { + "type": "object", + "properties": {} + }, + "marketplace.module_data_management": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XB[0-9a-fA-F]{32}$", + "nullable": true + }, + "description": { + "nullable": true + }, + "support": { + "nullable": true + }, + "policies": { + "nullable": true + }, + "module_info": { + "nullable": true + }, + "documentation": { + "nullable": true + } + } + } + } + }, + "info": { + "title": "Twilio - Marketplace", + "description": "This is the public Twilio REST API.", + "termsOfService": "https://www.twilio.com/legal/tos", + "contact": { + "name": "Twilio Support", + "url": "https://support.twilio.com", + "email": "support@twilio.com" + }, + "license": { + "name": "Apache 2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0.html" + }, + "version": "1.0.0" + }, + "openapi": "3.0.1", + "paths": { + "/v1/AvailableAddOns": { + "servers": [ + { + "url": "https://marketplace.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "dependentProperties": { + "extensions": { + "mapping": { + "available_add_on_sid": "sid" + }, + "resource_url": "/v1/AvailableAddOns/{available_add_on_sid}/Extensions" + } + }, + "pathType": "list" + }, + "get": { + "description": "Retrieve a list of Add-ons currently available to be installed.", + "tags": [ + "MarketplaceAvailableAddOn" + ], + "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/marketplace.available_add_on" + } + }, + "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": { + "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://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "extensions": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://marketplace.twilio.com/v1/AvailableAddOns?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://marketplace.twilio.com/v1/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://marketplace.twilio.com/v1/AvailableAddOns?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://marketplace.twilio.com/v1/AvailableAddOns?PageSize=50&Page=0", + "next_page_url": null, + "key": "available_add_ons" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListMarketplaceAvailableAddOn" + } + }, + "/v1/AvailableAddOns/{Sid}": { + "servers": [ + { + "url": "https://marketplace.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "dependentProperties": { + "extensions": { + "mapping": { + "available_add_on_sid": "sid" + }, + "resource_url": "/v1/AvailableAddOns/{available_add_on_sid}/Extensions" + } + }, + "pathType": "instance" + }, + "get": { + "description": "Fetch an instance of an Add-on currently available to be installed.", + "tags": [ + "MarketplaceAvailableAddOn" + ], + "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/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://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "extensions": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchMarketplaceAvailableAddOn" + } + }, + "/v1/AvailableAddOns/{AvailableAddOnSid}/Extensions": { + "servers": [ + { + "url": "https://marketplace.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "parent": "/AvailableAddOns/{Sid}", + "className": "available_add_on_extension", + "pathType": "list" + }, + "get": { + "description": "Retrieve a list of Extensions for the Available Add-on.", + "tags": [ + "MarketplaceAvailableAddOnExtension" + ], + "parameters": [ + { + "name": "AvailableAddOnSid", + "in": "path", + "description": "The SID of the AvailableAddOn resource with the extensions to read.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XB[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListMarketplaceAvailableAddOnExtensionResponse", + "properties": { + "extensions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/marketplace.available_add_on.available_add_on_extension" + } + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + }, + "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://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://marketplace.twilio.com/v1/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://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", + "next_page_url": null, + "key": "extensions" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListMarketplaceAvailableAddOnExtension" + } + }, + "/v1/AvailableAddOns/{AvailableAddOnSid}/Extensions/{Sid}": { + "servers": [ + { + "url": "https://marketplace.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "parent": "/AvailableAddOns/{Sid}", + "className": "available_add_on_extension", + "pathType": "instance" + }, + "get": { + "description": "Fetch an instance of an Extension for the Available Add-on.", + "tags": [ + "MarketplaceAvailableAddOnExtension" + ], + "parameters": [ + { + "name": "AvailableAddOnSid", + "in": "path", + "description": "The SID of the AvailableAddOn resource with the extension to fetch.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XB[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The SID of the AvailableAddOn Extension resource to fetch.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XF[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/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://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchMarketplaceAvailableAddOnExtension" + } + }, + "/v1/InstalledAddOns": { + "servers": [ + { + "url": "https://marketplace.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "dependentProperties": { + "extensions": { + "mapping": { + "installed_add_on_sid": "sid" + }, + "resource_url": "/v1/InstalledAddOns/{installed_add_on_sid}/Extensions" + }, + "usage": { + "mapping": { + "installed_add_on_sid": "sid" + }, + "resource_url": "/v1/InstalledAddOns/{installed_add_on_sid}/Usage" + } + }, + "pathType": "list" + }, + "post": { + "description": "Install an Add-on for the Account specified.", + "tags": [ + "MarketplaceInstalledAddOn" + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/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://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "extensions": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions", + "available_add_on": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "Created" + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "type": "object", + "x-jvm-type": "com.twilio.rest.TwilioServiceErrorResponse" + } + } + } + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateMarketplaceInstalledAddOn", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateMarketplaceInstalledAddOnRequest", + "properties": { + "AvailableAddOnSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XB[0-9a-fA-F]{32}$", + "description": "The SID of the AvaliableAddOn to install." + }, + "AcceptTermsOfService": { + "type": "boolean", + "description": "Whether the Terms of Service were accepted." + }, + "Configuration": { + "description": "The JSON object that represents the configuration of the new Add-on being installed." + }, + "UniqueName": { + "type": "string", + "description": "An application-defined string that uniquely identifies the resource. This value must be unique within the Account." + } + }, + "required": [ + "AvailableAddOnSid", + "AcceptTermsOfService" + ] + }, + "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.", + "tags": [ + "MarketplaceInstalledAddOn" + ], + "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": "ListMarketplaceInstalledAddOnResponse", + "properties": { + "installed_add_ons": { + "type": "array", + "items": { + "$ref": "#/components/schemas/marketplace.installed_add_on" + } + }, + "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": { + "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://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "extensions": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions", + "available_add_on": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://marketplace.twilio.com/v1/InstalledAddOns?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://marketplace.twilio.com/v1/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://marketplace.twilio.com/v1/InstalledAddOns?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://marketplace.twilio.com/v1/InstalledAddOns?PageSize=50&Page=0", + "next_page_url": null, + "key": "installed_add_ons" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListMarketplaceInstalledAddOn" + } + }, + "/v1/InstalledAddOns/{Sid}": { + "servers": [ + { + "url": "https://marketplace.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "dependentProperties": { + "extensions": { + "mapping": { + "installed_add_on_sid": "sid" + }, + "resource_url": "/v1/InstalledAddOns/{installed_add_on_sid}/Extensions" + }, + "usage": { + "mapping": { + "installed_add_on_sid": "sid" + }, + "resource_url": "/v1/InstalledAddOns/{installed_add_on_sid}/Usage" + } + }, + "pathType": "instance" + }, + "delete": { + "description": "Remove an Add-on installation from your account", + "tags": [ + "MarketplaceInstalledAddOn" + ], + "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 an instance of an Add-on currently installed on this Account.", + "tags": [ + "MarketplaceInstalledAddOn" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "The SID of the InstalledAddOn resource to fetch.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XE[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/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://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "extensions": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions", + "available_add_on": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchMarketplaceInstalledAddOn" + }, + "post": { + "description": "Update an Add-on installation for the Account specified.", + "tags": [ + "MarketplaceInstalledAddOn" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "The SID of the InstalledAddOn resource to update.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XE[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/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://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "extensions": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions", + "available_add_on": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateMarketplaceInstalledAddOn", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateMarketplaceInstalledAddOnRequest", + "properties": { + "Configuration": { + "description": "Valid JSON object that conform to the configuration schema exposed by the associated AvailableAddOn resource. This is only required by Add-ons that need to be configured" + }, + "UniqueName": { + "type": "string", + "description": "An application-defined string that uniquely identifies the resource. This value must be unique within the Account." + } + } + }, + "examples": { + "update": { + "value": { + "Configuration": "{\"bad_words\": true}", + "UniqueName": "voicebase_high_accuracy_transcription_2" + } + } + } + } + } + } + } + }, + "/v1/InstalledAddOns/{InstalledAddOnSid}/Extensions": { + "servers": [ + { + "url": "https://marketplace.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "parent": "/InstalledAddOns/{Sid}", + "className": "installed_add_on_extension", + "pathType": "list" + }, + "get": { + "description": "Retrieve a list of Extensions for the Installed Add-on.", + "tags": [ + "MarketplaceInstalledAddOnExtension" + ], + "parameters": [ + { + "name": "InstalledAddOnSid", + "in": "path", + "description": "The SID of the InstalledAddOn resource with the extensions to read.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XE[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListMarketplaceInstalledAddOnExtensionResponse", + "properties": { + "extensions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/marketplace.installed_add_on.installed_add_on_extension" + } + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + }, + "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://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://marketplace.twilio.com/v1/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://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", + "next_page_url": null, + "key": "extensions" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListMarketplaceInstalledAddOnExtension" + } + }, + "/v1/InstalledAddOns/{InstalledAddOnSid}/Extensions/{Sid}": { + "servers": [ + { + "url": "https://marketplace.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.", + "tags": [ + "MarketplaceInstalledAddOnExtension" + ], + "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/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://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchMarketplaceInstalledAddOnExtension" + }, + "post": { + "description": "Update an Extension for an Add-on installation.", + "tags": [ + "MarketplaceInstalledAddOnExtension" + ], + "parameters": [ + { + "name": "InstalledAddOnSid", + "in": "path", + "description": "The SID of the InstalledAddOn resource with the extension to update.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XE[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The SID of the InstalledAddOn Extension resource to update.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XF[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/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://marketplace.twilio.com/v1/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateMarketplaceInstalledAddOnExtension", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateMarketplaceInstalledAddOnExtensionRequest", + "properties": { + "Enabled": { + "type": "boolean", + "description": "Whether the Extension should be invoked." + } + }, + "required": [ + "Enabled" + ] + }, + "examples": { + "update": { + "value": { + "Enabled": false + } + } + } + } + } + } + } + }, + "/v1/InstalledAddOns/{InstalledAddOnSid}/Usage": { + "servers": [ + { + "url": "https://marketplace.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "parent": "/InstalledAddOns/{Sid}", + "className": "installed_add_on_usage", + "pathType": "list" + }, + "post": { + "description": "", + "tags": [ + "MarketplaceBillingUsage" + ], + "parameters": [ + { + "name": "InstalledAddOnSid", + "in": "path", + "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XE[0-9a-fA-F]{32}$" + }, + "required": true, + "example": "BIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "responses": { + "202": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/marketplace.installed_add_on.billing_usage_response" + }, + "examples": { + "create": { + "value": {} + } + } + } + }, + "description": "Accepted" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateMarketplaceBillingUsage", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "billable_items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "quantity": { + "type": "number", + "description": "" + }, + "sid": { + "type": "string", + "description": "" + } + }, + "required": [ + "quantity", + "sid" + ] + } + } + } + }, + "examples": { + "multiple_sids": { + "value": { + "billable_items": [ + { + "sid": "BIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "quantity": 12.355 + }, + { + "sid": "BIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "quantity": 44.02 + } + ] + } + } + } + } + } + } + } + }, + "/v1/Listing/{Sid}": { + "servers": [ + { + "url": "https://marketplace.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "mountName": "module_data_management", + "pathType": "instance" + }, + "post": { + "description": "", + "tags": [ + "MarketplaceModuleDataManagement" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XB[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/marketplace.module_data_management" + }, + "examples": { + "update": { + "value": { + "sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://marketplace.twilio.com/v1/Listing/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": { + "body": "aBody", + "highlights": [ + { + "title": "aTitle", + "description": "aDescription" + } + ], + "code_samples": [ + { + "title": "aTitle", + "description": "aDescription", + "code": "aCode" + } + ] + }, + "support": { + "customer_support_email": "anEmail", + "customer_support_phone": "+1 888-888-8888", + "support_description": "aDescription", + "billing_email": "anEmail", + "billing_phone": "+1 888-888-8888", + "technical_email": "anEmail", + "technical_phone": "+1 888-888-8888" + }, + "policies": { + "privacy": "someUrl", + "legal": "someOtherUrl" + }, + "module_info": { + "tag": "Description", + "tagline": "aTagline", + "logo_url": "aUrl", + "logo_bg_color_hex": "#ff5722" + }, + "documentation": { + "body": "aBody" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + }, + "304": { + "description": "Not Modified" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateMarketplaceModuleDataManagement", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateMarketplaceModuleDataManagementRequest", + "properties": { + "ModuleInfo": { + "type": "string", + "description": "" + }, + "Description": { + "type": "string", + "description": "" + }, + "Documentation": { + "type": "string", + "description": "" + }, + "Policies": { + "type": "string", + "description": "" + }, + "Support": { + "type": "string", + "description": "" + } + } + }, + "examples": { + "update": { + "value": { + "ModuleInfo": "test", + "Description": "test", + "Documentation": "test", + "Policies": "test", + "Support": "test" + } + } + } + } + } + } + }, + "get": { + "description": "", + "tags": [ + "MarketplaceModuleDataManagement" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XB[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/marketplace.module_data_management" + }, + "examples": { + "fetch": { + "value": { + "sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://marketplace.twilio.com/v1/Listing/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": { + "body": "aBody", + "highlights": [ + { + "title": "aTitle", + "description": "aDescription" + } + ], + "code_samples": [ + { + "title": "aTitle", + "description": "aDescription", + "code": "aCode" + } + ] + }, + "support": { + "customer_support_email": "anEmail", + "customer_support_phone": "+1 888-888-8888", + "support_description": "aDescription", + "billing_email": "anEmail", + "billing_phone": "+1 888-888-8888", + "technical_email": "anEmail", + "technical_phone": "+1 888-888-8888" + }, + "policies": { + "privacy": "someUrl", + "legal": "someOtherUrl" + }, + "module_info": { + "tag": "Description", + "tagline": "aTagline", + "logo_url": "aUrl", + "logo_bg_color_hex": "#ff5722" + }, + "documentation": { + "body": "aBody" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchMarketplaceModuleDataManagement" + } + } + }, + "servers": [ + { + "url": "https://marketplace.twilio.com" + } + ], + "tags": [ + { + "name": "MarketplaceAvailableAddOn" + }, + { + "name": "MarketplaceAvailableAddOnExtension" + }, + { + "name": "MarketplaceBillingUsage" + }, + { + "name": "MarketplaceInstalledAddOn" + }, + { + "name": "MarketplaceInstalledAddOnExtension" + }, + { + "name": "MarketplaceInstalledAddOnUsage" + }, + { + "name": "MarketplaceModuleDataManagement" + } + ], + "security": [ + { + "accountSid_authToken": [] + } + ] +} \ No newline at end of file diff --git a/src/services/twilio-api/twilio_messaging_v1.json b/src/services/twilio-api/twilio_messaging_v1.json index 8f65e8b8..d6efb9dc 100644 --- a/src/services/twilio-api/twilio_messaging_v1.json +++ b/src/services/twilio-api/twilio_messaging_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "messaging.v1.service.alpha_sender": { "type": "object", @@ -1376,12 +1382,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" + ] } } }, @@ -1398,7 +1429,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -1414,8 +1445,8 @@ "sid", "alpha_sender" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -1442,6 +1473,58 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1454,9 +1537,6 @@ } ], "operationId": "CreateAlphaSender", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1472,6 +1552,13 @@ "required": [ "AlphaSender" ] + }, + "examples": { + "create": { + "value": { + "AlphaSender": "Twilio" + } + } } } } @@ -1537,16 +1624,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1555,21 +1644,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" } }, "title": "ListAlphaSenderResponse" + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 20, + "first_page_url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders?PageSize=20&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "alpha_senders", + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders?PageSize=20&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" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1581,10 +1733,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAlphaSender", - "x-maturity": [ - "Beta" - ] + "operationId": "ListAlphaSender" } }, "/v1/Services/{ServiceSid}/AlphaSenders/{Sid}": { @@ -1599,8 +1748,8 @@ "sid", "alpha_sender" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -1636,6 +1785,58 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1647,10 +1848,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAlphaSender", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchAlphaSender" }, "delete": { "description": "", @@ -1690,10 +1888,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteAlphaSender", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteAlphaSender" } }, "/v1/a2p/BrandRegistrations/{BrandRegistrationSid}/SmsOtp": { @@ -1708,9 +1903,9 @@ "account_sid", "brand_registration_sid" ], - "pathType": "list", "parent": "/a2p/BrandRegistrations/{Sid}", - "mountName": "brand_registration_otps" + "mountName": "brand_registration_otps", + "pathType": "list" }, "post": { "description": "", @@ -1737,6 +1932,50 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.brand_registrations.brand_registration_otp" + }, + "examples": { + "create": { + "value": { + "account_sid": "AC78e8e67fc0246521490fb9907fd0c165", + "brand_registration_sid": "BN0044409f7e067e279523808d267e2d85" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1748,10 +1987,7 @@ "accountSid_authToken": [] } ], - "operationId": "CreateBrandRegistrationOtp", - "x-maturity": [ - "Beta" - ] + "operationId": "CreateBrandRegistrationOtp" } }, "/v1/a2p/BrandRegistrations/{Sid}": { @@ -1766,7 +2002,6 @@ "sid", "date_created" ], - "pathType": "instance", "dependentProperties": { "brand_vettings": { "mapping": { @@ -1780,7 +2015,8 @@ }, "resource_url": "/v1/a2p/BrandRegistrations/{brand_registration_sid}/SmsOtp" } - } + }, + "pathType": "instance" }, "get": { "description": "", @@ -1807,6 +2043,187 @@ "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, + "errors": [], + "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, + "errors": [], + "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, + "errors": [], + "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, + "errors": [], + "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, + "errors": [], + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1818,10 +2235,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchBrandRegistrations", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchBrandRegistrations" }, "post": { "description": "", @@ -1848,6 +2262,103 @@ "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, + "errors": [], + "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, + "errors": [], + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1859,10 +2370,7 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateBrandRegistrations", - "x-maturity": [ - "Beta" - ] + "operationId": "UpdateBrandRegistrations" } }, "/v1/a2p/BrandRegistrations": { @@ -1877,7 +2385,6 @@ "sid", "date_created" ], - "pathType": "list", "dependentProperties": { "brand_vettings": { "mapping": { @@ -1891,7 +2398,8 @@ }, "resource_url": "/v1/a2p/BrandRegistrations/{brand_registration_sid}/SmsOtp" } - } + }, + "pathType": "list" }, "get": { "description": "", @@ -1941,16 +2449,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1959,21 +2469,154 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListBrandRegistrationsResponse" + }, + "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, + "errors": [], + "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" + } + } + ] + } + }, + "readFailed": { + "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, + "errors": [ + { + "url": "https://www.twilio.com/docs/api/errors/30701", + "error_code": 30701, + "description": "Invalid State/Region/Province. please check the input field value [Max length 20, For The United States, please use 2 character codes. E.g. 'CA' for California] and retry.", + "fields": [ + "region" + ] + } + ], + "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" + } + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1985,10 +2628,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListBrandRegistrations", - "x-maturity": [ - "Beta" - ] + "operationId": "ListBrandRegistrations" }, "post": { "description": "", @@ -2001,6 +2641,103 @@ "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, + "errors": [], + "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, + "errors": [], + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2013,9 +2750,6 @@ } ], "operationId": "CreateBrandRegistrations", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2054,6 +2788,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 + } + } } } } @@ -2077,9 +2831,9 @@ "vetting_status", "vetting_class" ], - "pathType": "list", "parent": "/a2p/BrandRegistrations/{Sid}", - "mountName": "brand_vettings" + "mountName": "brand_vettings", + "pathType": "list" }, "post": { "description": "", @@ -2106,6 +2860,58 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2118,9 +2924,6 @@ } ], "operationId": "CreateBrandVetting", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2141,6 +2944,14 @@ "required": [ "VettingProvider" ] + }, + "examples": { + "create": { + "value": { + "VettingProvider": "campaign-verify", + "VettingId": "cv|1.0|tcr|10dlc|9975c339-d46f-49b7-a399-EXAMPLETOKEN|GQ3EXAMPLETOKENAXXBUNBT2AgL-LdQuPveFhEyY" + } + } } } } @@ -2215,16 +3026,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2233,21 +3046,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" } }, "title": "ListBrandVettingResponse" + }, + "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" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2259,10 +3135,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListBrandVetting", - "x-maturity": [ - "Beta" - ] + "operationId": "ListBrandVetting" } }, "/v1/a2p/BrandRegistrations/{BrandSid}/Vettings/{BrandVettingSid}": { @@ -2282,9 +3155,9 @@ "vetting_status", "vetting_class" ], - "pathType": "instance", "parent": "/a2p/BrandRegistrations/{Sid}", - "mountName": "brand_vettings" + "mountName": "brand_vettings", + "pathType": "instance" }, "get": { "description": "", @@ -2323,7 +3196,59 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -2334,10 +3259,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchBrandVetting", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchBrandVetting" } }, "/v1/Services/{MessagingServiceSid}/ChannelSenders": { @@ -2353,8 +3275,8 @@ "sender", "sender_type" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -2416,16 +3338,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2434,21 +3358,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" } }, "title": "ListChannelSenderResponse" + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 20, + "first_page_url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders?PageSize=20&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "senders", + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders?PageSize=20&Page=0" + }, + "senders": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sender": "whatsapp:+12487960483", + "sender_type": "WhatsApp", + "country_code": "US", + "date_created": "2023-07-30T20:12:31Z", + "date_updated": "2023-07-30T20:12:33Z", + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2460,10 +3446,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListChannelSender", - "x-maturity": [ - "Beta" - ] + "operationId": "ListChannelSender" } }, "/v1/Services/{MessagingServiceSid}/ChannelSenders/{Sid}": { @@ -2479,8 +3462,8 @@ "sender", "sender_type" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -2516,6 +3499,57 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.service.channel_sender" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sender": "whatsapp:+12487960483", + "sender_type": "WhatsApp", + "country_code": "US", + "date_created": "2023-07-30T20:12:31Z", + "date_updated": "2023-07-30T20:12:33Z", + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2527,10 +3561,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchChannelSender", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchChannelSender" } }, "/v1/Deactivations": { @@ -2544,8 +3575,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.", @@ -2569,6 +3600,49 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.deactivation" + }, + "examples": { + "fetch": { + "value": { + "redirect_to": "https://com-twilio-dev-messaging-deactivations.s3.amazonaws.com" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2580,10 +3654,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDeactivation", - "x-maturity": [ - "GA" - ] + "operationId": "FetchDeactivation" } }, "/v1/LinkShortening/Domains/{DomainSid}/Certificate": { @@ -2592,7 +3663,7 @@ "url": "https://messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "certificate_sid", @@ -2603,9 +3674,9 @@ "date_updated", "url" ], - "pathType": "instance", "mountName": "domain_certs", - "className": "domain_certs" + "className": "domain_certs", + "pathType": "instance" }, "post": { "description": "", @@ -2632,6 +3703,59 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2642,6 +3766,59 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2654,9 +3831,6 @@ } ], "operationId": "UpdateDomainCertV4", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2672,6 +3846,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-----" + } + } } } } @@ -2702,6 +3888,59 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2713,10 +3952,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDomainCertV4", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchDomainCertV4" }, "delete": { "description": "", @@ -2747,10 +3983,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteDomainCertV4", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteDomainCertV4" } }, "/v1/LinkShortening/Domains/{DomainSid}/Config": { @@ -2759,7 +3992,7 @@ "url": "https://messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "config_sid", @@ -2771,8 +4004,8 @@ "url", "disable_https" ], - "pathType": "instance", - "mountName": "domain_config" + "mountName": "domain_config", + "pathType": "instance" }, "post": { "description": "", @@ -2799,6 +4032,57 @@ "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2809,6 +4093,57 @@ "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2821,9 +4156,6 @@ } ], "operationId": "UpdateDomainConfig", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2850,12 +4182,27 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -2883,6 +4230,57 @@ "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2894,10 +4292,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDomainConfig", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchDomainConfig" } }, "/v1/LinkShortening/MessagingService/{MessagingServiceSid}/DomainConfig": { @@ -2906,7 +4301,7 @@ "url": "https://messaging.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "domain_sid", @@ -2919,8 +4314,8 @@ "url", "messaging_service_sid" ], - "pathType": "instance", - "mountName": "domain_config_messaging_service" + "mountName": "domain_config_messaging_service", + "pathType": "instance" }, "get": { "description": "", @@ -2947,6 +4342,57 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2958,10 +4404,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDomainConfigMessagingService", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchDomainConfigMessagingService" } }, "/v1/Services/PreregisteredUsa2p": { @@ -2976,8 +4419,8 @@ "campaign_id", "messaging_service_sid" ], - "pathType": "list", - "mountName": "external_campaign" + "mountName": "external_campaign", + "pathType": "list" }, "post": { "description": "", @@ -2990,6 +4433,53 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3002,9 +4492,6 @@ } ], "operationId": "CreateExternalCampaign", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3028,6 +4515,14 @@ "CampaignId", "MessagingServiceSid" ] + }, + "examples": { + "create": { + "value": { + "MessagingServiceSid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "CampaignId": "CMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -3040,15 +4535,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": "", @@ -3087,6 +4582,51 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3098,10 +4638,7 @@ "accountSid_authToken": [] } ], - "operationId": "CreateLinkshorteningMessagingService", - "x-maturity": [ - "Beta" - ] + "operationId": "CreateLinkshorteningMessagingService" }, "delete": { "description": "", @@ -3144,10 +4681,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteLinkshorteningMessagingService", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteLinkshorteningMessagingService" } }, "/v1/LinkShortening/MessagingServices/{MessagingServiceSid}/Domain": { @@ -3156,15 +4690,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": "", @@ -3191,6 +4725,51 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3202,10 +4781,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchLinkshorteningMessagingServiceDomainAssociation", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchLinkshorteningMessagingServiceDomainAssociation" } }, "/v1/Services/{ServiceSid}/PhoneNumbers": { @@ -3221,9 +4797,9 @@ "phone_number", "country_code" ], - "pathType": "list", - "parent": "/Services/{Sid}" - }, + "parent": "/Services/{Sid}", + "pathType": "list" + }, "post": { "description": "", "tags": [ @@ -3249,6 +4825,74 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3261,9 +4905,6 @@ } ], "operationId": "CreatePhoneNumber", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3282,6 +4923,18 @@ "required": [ "PhoneNumberSid" ] + }, + "examples": { + "create": { + "value": { + "PhoneNumberSid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createWithCapabilities": { + "value": { + "PhoneNumberSid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -3347,16 +5000,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3365,21 +5020,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" } }, "title": "ListPhoneNumberResponse" + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 20, + "first_page_url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=20&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "phone_numbers", + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=20&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" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3391,10 +5108,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListPhoneNumber", - "x-maturity": [ - "Beta" - ] + "operationId": "ListPhoneNumber" } }, "/v1/Services/{ServiceSid}/PhoneNumbers/{Sid}": { @@ -3410,8 +5124,8 @@ "phone_number", "country_code" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "delete": { "description": "", @@ -3451,10 +5165,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeletePhoneNumber", - "x-maturity": [ - "Beta" - ] + "operationId": "DeletePhoneNumber" }, "get": { "description": "", @@ -3490,6 +5201,57 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3501,10 +5263,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchPhoneNumber", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchPhoneNumber" } }, "/v1/Services": { @@ -3520,7 +5279,6 @@ "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { "phone_numbers": { "mapping": { @@ -3564,7 +5322,8 @@ }, "resource_url": "/v1/Services/{messaging_service_sid}/ChannelSenders" } - } + }, + "pathType": "list" }, "post": { "description": "", @@ -3577,6 +5336,80 @@ "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, + "sending_windows": [], + "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", + "channel_senders": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders" + }, + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3589,9 +5422,6 @@ } ], "operationId": "CreateService", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3681,6 +5511,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 + } + } } } } @@ -3734,16 +5586,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3752,21 +5606,111 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListServiceResponse" + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 20, + "first_page_url": "https://messaging.twilio.com/v1/Services?PageSize=20&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "services", + "url": "https://messaging.twilio.com/v1/Services?PageSize=20&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, + "sending_windows": [ + { + "start_time": "10:00", + "end_time": "21:00" + } + ], + "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", + "channel_senders": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders" + }, + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3778,10 +5722,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListService", - "x-maturity": [ - "Beta" - ] + "operationId": "ListService" } }, "/v1/Services/{Sid}": { @@ -3797,7 +5738,6 @@ "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { "phone_numbers": { "mapping": { @@ -3841,7 +5781,8 @@ }, "resource_url": "/v1/Services/{messaging_service_sid}/ChannelSenders" } - } + }, + "pathType": "instance" }, "post": { "description": "", @@ -3868,6 +5809,80 @@ "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, + "sending_windows": [], + "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", + "channel_senders": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders" + }, + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3880,9 +5895,6 @@ } ], "operationId": "UpdateService", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3969,12 +5981,16 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -4002,6 +6018,85 @@ "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, + "sending_windows": [ + { + "start_time": "10:00", + "end_time": "21:00" + } + ], + "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", + "channel_senders": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders" + }, + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4013,10 +6108,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchService", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchService" }, "delete": { "description": "", @@ -4047,10 +6139,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteService", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteService" } }, "/v1/Services/{ServiceSid}/ShortCodes": { @@ -4066,8 +6155,8 @@ "short_code", "country_code" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -4094,6 +6183,59 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4106,9 +6248,6 @@ } ], "operationId": "CreateShortCode", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4127,6 +6266,13 @@ "required": [ "ShortCodeSid" ] + }, + "examples": { + "create": { + "value": { + "ShortCodeSid": "SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -4192,16 +6338,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4210,21 +6358,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" } }, "title": "ListShortCodeResponse" + }, + "examples": { + "readFull": { + "value": { + "meta": { + "page": 0, + "page_size": 20, + "first_page_url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes?PageSize=20&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "short_codes", + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes?PageSize=20&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" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4236,10 +6448,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListShortCode", - "x-maturity": [ - "Beta" - ] + "operationId": "ListShortCode" } }, "/v1/Services/{ServiceSid}/ShortCodes/{Sid}": { @@ -4255,8 +6464,8 @@ "short_code", "country_code" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "delete": { "description": "", @@ -4296,10 +6505,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteShortCode", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteShortCode" }, "get": { "description": "", @@ -4335,6 +6541,59 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4346,10 +6605,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchShortCode", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchShortCode" } }, "/v1/Tollfree/Verifications/{Sid}": { @@ -4364,8 +6620,8 @@ "sid", "date_created" ], - "pathType": "instance", - "mountName": "tollfree_verifications" + "mountName": "tollfree_verifications", + "pathType": "instance" }, "get": { "description": "", @@ -4392,6 +6648,95 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.tollfree_verification" + }, + "examples": { + "fetch": { + "value": { + "sid": "HHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trust_product_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "regulated_item_sid": "RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2021-01-27T14:18:35Z", + "date_updated": "2021-01-27T14:18:36Z", + "business_name": "Owl, Inc.", + "business_street_address": "123 Main Street", + "business_street_address2": "Suite 101", + "business_city": "Anytown", + "business_state_province_region": "AA", + "business_postal_code": "11111", + "business_country": "US", + "business_website": "http://www.company.com", + "business_contact_first_name": "firstname", + "business_contact_last_name": "lastname", + "business_contact_email": "email@company.com", + "business_contact_phone": "+11231231234", + "notification_email": "support@company.com", + "use_case_categories": [ + "TWO_FACTOR_AUTHENTICATION", + "MARKETING" + ], + "use_case_summary": "This number is used to send out promotional offers and coupons to the customers of John's Coffee Shop", + "production_message_sample": "lorem ipsum", + "opt_in_image_urls": [ + "https://testbusiness.com/images/image1.jpg", + "https://testbusiness.com/images/image2.jpg" + ], + "opt_in_type": "VERBAL", + "message_volume": "2000", + "additional_information": "see our privacy policy here www.johnscoffeeshop.com/privacypolicy", + "tollfree_phone_number_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "TWILIO_APPROVED", + "rejection_reason": null, + "error_code": null, + "edit_expiration": null, + "edit_allowed": null, + "rejection_reasons": null, + "resource_links": { + "customer_profile": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trust_product": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_endpoint_assignment": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "url": "https://messaging.twilio.com/v1/Tollfree/Verifications/HHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "external_reference_id": "abc123xyz567" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4403,10 +6748,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTollfreeVerification", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchTollfreeVerification" }, "post": { "description": "", @@ -4433,6 +6775,91 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.tollfree_verification" + }, + "examples": { + "update": { + "value": { + "sid": "HHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "regulated_item_sid": null, + "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trust_product_sid": null, + "status": "PENDING_REVIEW", + "date_created": "2021-01-27T14:18:35Z", + "date_updated": "2021-01-27T14:18:36Z", + "business_name": "Owl, Inc.", + "business_street_address": "123 Main Street", + "business_street_address2": "Suite 101", + "business_city": "Anytown", + "business_state_province_region": "AA", + "business_postal_code": "11111", + "business_country": "US", + "business_website": "http://www.company.com", + "business_contact_first_name": "firstname", + "business_contact_last_name": "lastname", + "business_contact_email": "email@company.com", + "business_contact_phone": "+11231231234", + "notification_email": "support@company.com", + "use_case_categories": [ + "TWO_FACTOR_AUTHENTICATION", + "MARKETING" + ], + "use_case_summary": "This number is used to send out promotional offers and coupons to the customers of John's Coffee Shop", + "production_message_sample": "lorem ipsum", + "opt_in_image_urls": [ + "https://testbusiness.com/images/image1.jpg", + "https://testbusiness.com/images/image2.jpg" + ], + "opt_in_type": "VERBAL", + "message_volume": "1,000", + "additional_information": "see our privacy policy here www.johnscoffeeshop.com/privacypolicy", + "tollfree_phone_number_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "rejection_reason": null, + "error_code": null, + "edit_expiration": null, + "edit_allowed": null, + "rejection_reasons": null, + "resource_links": {}, + "url": "https://messaging.twilio.com/v1/Tollfree/Verifications/HHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "external_reference_id": null + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4445,9 +6872,6 @@ } ], "operationId": "UpdateTollfreeVerification", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4548,12 +6972,42 @@ "description": "Describe why the verification is being edited. If the verification was rejected because of a technical issue, such as the website being down, and the issue has been resolved this parameter should be set to something similar to 'Website fixed'." } } + }, + "examples": { + "update": { + "value": { + "BusinessName": "Owl, Inc.", + "BusinessStreetAddress": "123 Main Street", + "BusinessStreetAddress2": "Suite 101", + "BusinessCity": "Anytown", + "BusinessStateProvinceRegion": "AA", + "BusinessPostalCode": "11111", + "BusinessCountry": "US", + "BusinessWebsite": "http://www.company.com", + "BusinessContactFirstName": "firstname", + "BusinessContactLastName": "lastname", + "BusinessContactEmail": "email@company.com", + "BusinessContactPhone": "+11231231234", + "NotificationEmail": "support@company.com", + "UseCaseCategories": [ + "TWO_FACTOR_AUTHENTICATION", + "MARKETING" + ], + "UseCaseSummary": "This number is used to send out promotional offers and coupons to the customers of John's Coffee Shop", + "ProductionMessageSample": "lorem ipsum", + "OptInImageUrls": [ + "https://testbusiness.com/images/image1.jpg", + "https://testbusiness.com/images/image2.jpg" + ], + "OptInType": "VERBAL", + "MessageVolume": "1,000", + "AdditionalInformation": "see our privacy policy here www.johnscoffeeshop.com/privacypolicy", + "EditReason": "Website fixed" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -4585,10 +7039,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteTollfreeVerification", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteTollfreeVerification" } }, "/v1/Tollfree/Verifications": { @@ -4603,8 +7054,8 @@ "sid", "date_created" ], - "pathType": "list", - "mountName": "tollfree_verifications" + "mountName": "tollfree_verifications", + "pathType": "list" }, "get": { "description": "", @@ -4621,6 +7072,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^PN[0-9a-fA-F]{32}$" + }, + "examples": { + "read": { + "value": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -4630,6 +7086,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/tollfree_verification_enum_status" + }, + "examples": { + "read": { + "value": "TWILIO_APPROVED" + } } }, { @@ -4638,6 +7099,11 @@ "description": "Customer supplied reference id for the Tollfree Verification record.", "schema": { "type": "string" + }, + "examples": { + "read": { + "value": "abc123xyz567" + } } }, { @@ -4646,6 +7112,11 @@ "description": "Whether to include Tollfree Verifications from sub accounts in list response.", "schema": { "type": "boolean" + }, + "examples": { + "read": { + "value": false + } } }, { @@ -4690,16 +7161,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4708,21 +7181,121 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListTollfreeVerificationResponse" + }, + "examples": { + "read": { + "value": { + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://messaging.twilio.com/v1/Tollfree/Verifications?Status=TWILIO_APPROVED&ExternalReferenceId=abc123xyz567&TollfreePhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&IncludeSubAccounts=False&PageSize=50&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "verifications", + "url": "https://messaging.twilio.com/v1/Tollfree/Verifications?Status=TWILIO_APPROVED&ExternalReferenceId=abc123xyz567&TollfreePhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&IncludeSubAccounts=False&PageSize=50&Page=0" + }, + "verifications": [ + { + "sid": "HHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trust_product_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "regulated_item_sid": "RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2021-01-27T14:18:35Z", + "date_updated": "2021-01-27T14:18:36Z", + "business_name": "Owl, Inc.", + "business_street_address": "123 Main Street", + "business_street_address2": "Suite 101", + "business_city": "Anytown", + "business_state_province_region": "AA", + "business_postal_code": "11111", + "business_country": "US", + "business_website": "http://www.company.com", + "business_contact_first_name": "firstname", + "business_contact_last_name": "lastname", + "business_contact_email": "email@company.com", + "business_contact_phone": "+11231231234", + "notification_email": "support@company.com", + "use_case_categories": [ + "TWO_FACTOR_AUTHENTICATION", + "MARKETING" + ], + "use_case_summary": "This number is used to send out promotional offers and coupons to the customers of John's Coffee Shop", + "production_message_sample": "lorem ipsum", + "opt_in_image_urls": [ + "https://testbusiness.com/images/image1.jpg", + "https://testbusiness.com/images/image2.jpg" + ], + "opt_in_type": "VERBAL", + "message_volume": "1,000", + "additional_information": "see our privacy policy here www.johnscoffeeshop.com/privacypolicy", + "tollfree_phone_number_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "TWILIO_APPROVED", + "url": "https://messaging.twilio.com/v1/Tollfree/Verifications/HHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "rejection_reason": null, + "error_code": null, + "edit_expiration": null, + "edit_allowed": null, + "rejection_reasons": null, + "resource_links": { + "customer_profile": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "trust_product": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "channel_endpoint_assignment": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "external_reference_id": "abc123xyz567" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4734,10 +7307,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTollfreeVerification", - "x-maturity": [ - "Beta" - ] + "operationId": "ListTollfreeVerification" }, "post": { "description": "", @@ -4750,6 +7320,138 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.tollfree_verification" + }, + "examples": { + "create": { + "value": { + "sid": "HHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "regulated_item_sid": null, + "customer_profile_sid": null, + "trust_product_sid": null, + "status": "PENDING_REVIEW", + "date_created": "2021-01-27T14:18:35Z", + "date_updated": "2021-01-27T14:18:36Z", + "business_name": "Owl, Inc.", + "business_street_address": "123 Main Street", + "business_street_address2": "Suite 101", + "business_city": "Anytown", + "business_state_province_region": "AA", + "business_postal_code": "11111", + "business_country": "US", + "business_website": "http://www.company.com", + "business_contact_first_name": "firstname", + "business_contact_last_name": "lastname", + "business_contact_email": "email@company.com", + "business_contact_phone": "+11231231234", + "notification_email": "support@company.com", + "use_case_categories": [ + "TWO_FACTOR_AUTHENTICATION", + "MARKETING" + ], + "use_case_summary": "This number is used to send out promotional offers and coupons to the customers of John's Coffee Shop", + "production_message_sample": "lorem ipsum", + "opt_in_image_urls": [ + "https://testbusiness.com/images/image1.jpg", + "https://testbusiness.com/images/image2.jpg" + ], + "opt_in_type": "VERBAL", + "message_volume": "10", + "additional_information": "see our privacy policy here www.johnscoffeeshop.com/privacypolicy", + "tollfree_phone_number_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "rejection_reason": null, + "error_code": null, + "edit_expiration": null, + "edit_allowed": null, + "rejection_reasons": null, + "resource_links": {}, + "url": "https://messaging.twilio.com/v1/Tollfree/Verifications/HHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "external_reference_id": "abc123xyz567" + } + }, + "create2": { + "value": { + "sid": "HHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "regulated_item_sid": null, + "trust_product_sid": null, + "business_name": "Owl, Inc.", + "status": "PENDING_REVIEW", + "date_created": "2021-01-27T14:18:35Z", + "date_updated": "2021-01-27T14:18:36Z", + "business_street_address": "123 Main Street", + "business_street_address2": "Suite 101", + "business_city": "Anytown", + "business_state_province_region": "AA", + "business_postal_code": "11111", + "business_country": "US", + "business_website": "http://www.company.com", + "business_contact_first_name": "firstname", + "business_contact_last_name": "lastname", + "business_contact_email": "email@company.com", + "business_contact_phone": "+11231231234", + "notification_email": "support@company.com", + "use_case_categories": [ + "TWO_FACTOR_AUTHENTICATION", + "MARKETING" + ], + "use_case_summary": "This number is used to send out promotional offers and coupons to the customers of John's Coffee Shop", + "production_message_sample": "lorem ipsum", + "opt_in_image_urls": [ + "https://testbusiness.com/images/image1.jpg", + "https://testbusiness.com/images/image2.jpg" + ], + "opt_in_type": "VERBAL", + "message_volume": "10", + "additional_information": "see our privacy policy here www.johnscoffeeshop.com/privacypolicy", + "tollfree_phone_number_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "rejection_reason": null, + "error_code": null, + "edit_expiration": null, + "edit_allowed": null, + "rejection_reasons": null, + "resource_links": {}, + "url": "https://messaging.twilio.com/v1/Tollfree/Verifications/HHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "external_reference_id": "abc123xyz567" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4762,9 +7464,6 @@ } ], "operationId": "CreateTollfreeVerification", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4891,6 +7590,63 @@ "MessageVolume", "TollfreePhoneNumberSid" ] + }, + "examples": { + "create": { + "value": { + "BusinessName": "Owl, Inc.", + "BusinessStreetAddress": "123 Main Street", + "BusinessStreetAddress2": "Suite 101", + "BusinessCity": "Anytown", + "BusinessStateProvinceRegion": "AA", + "BusinessPostalCode": "11111", + "BusinessCountry": "US", + "BusinessWebsite": "http://www.company.com", + "BusinessContactFirstName": "firstname", + "BusinessContactLastName": "lastname", + "BusinessContactEmail": "email@company.com", + "BusinessContactPhone": "+11231231234", + "NotificationEmail": "support@company.com", + "UseCaseCategories": [ + "TWO_FACTOR_AUTHENTICATION", + "MARKETING" + ], + "UseCaseSummary": "This number is used to send out promotional offers and coupons to the customers of John's Coffee Shop", + "ProductionMessageSample": "lorem ipsum", + "OptInImageUrls": [ + "https://testbusiness.com/images/image1.jpg", + "https://testbusiness.com/images/image2.jpg" + ], + "OptInType": "VERBAL", + "MessageVolume": "10", + "AdditionalInformation": "see our privacy policy here www.johnscoffeeshop.com/privacypolicy", + "TollfreePhoneNumberSid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ExternalReferenceId": "abc123xyz567" + } + }, + "create2": { + "value": { + "CustomerProfileSid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "BusinessName": "Owl, Inc.", + "BusinessWebsite": "http://www.company.com", + "NotificationEmail": "support@company.com", + "UseCaseCategories": [ + "TWO_FACTOR_AUTHENTICATION", + "MARKETING" + ], + "UseCaseSummary": "This number is used to send out promotional offers and coupons to the customers of John's Coffee Shop", + "ProductionMessageSample": "lorem ipsum", + "OptInImageUrls": [ + "https://testbusiness.com/images/image1.jpg", + "https://testbusiness.com/images/image2.jpg" + ], + "OptInType": "VERBAL", + "MessageVolume": "10", + "AdditionalInformation": "see our privacy policy here www.johnscoffeeshop.com/privacypolicy", + "TollfreePhoneNumberSid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ExternalReferenceId": "abc123xyz567" + } + } } } } @@ -4910,9 +7666,9 @@ "campaign_status", "date_created" ], - "pathType": "list", "parent": "/Services/{Sid}", - "mountName": "us_app_to_person" + "mountName": "us_app_to_person", + "pathType": "list" }, "post": { "description": "", @@ -4939,6 +7695,203 @@ "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, + "subscriber_opt_in": false, + "age_gated": false, + "direct_lending": 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, + "subscriber_opt_in": true, + "age_gated": false, + "direct_lending": 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, + "subscriber_opt_in": true, + "age_gated": false, + "direct_lending": 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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4951,9 +7904,6 @@ } ], "operationId": "CreateUsAppToPerson", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5050,6 +8000,77 @@ "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, + "SubscriberOptIn": false, + "AgeGated": false, + "DirectLending": 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, + "AgeGated": false, + "DirectLending": 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, + "AgeGated": false, + "DirectLending": false + } + } } } } @@ -5115,16 +8136,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5133,21 +8156,190 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListUsAppToPersonResponse" + }, + "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, + "subscriber_opt_in": true, + "age_gated": false, + "direct_lending": 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": 20, + "first_page_url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p?PageSize=20&Page=0", + "previous_page_url": null, + "next_page_url": null, + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p?PageSize=20&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, + "subscriber_opt_in": true, + "age_gated": false, + "direct_lending": 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": 20, + "first_page_url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p?PageSize=20&Page=0", + "previous_page_url": null, + "next_page_url": null, + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p?PageSize=20&Page=0", + "key": "compliance" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5159,10 +8351,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsAppToPerson", - "x-maturity": [ - "Beta" - ] + "operationId": "ListUsAppToPerson" } }, "/v1/Services/{MessagingServiceSid}/Compliance/Usa2p/{Sid}": { @@ -5178,9 +8367,9 @@ "campaign_status", "date_created" ], - "pathType": "instance", "parent": "/Services/{Sid}", - "mountName": "us_app_to_person" + "mountName": "us_app_to_person", + "pathType": "instance" }, "delete": { "description": "", @@ -5223,10 +8412,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUsAppToPerson", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteUsAppToPerson" }, "get": { "description": "", @@ -5265,6 +8451,200 @@ "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, + "subscriber_opt_in": true, + "age_gated": false, + "direct_lending": 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": [ + "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, + "subscriber_opt_in": true, + "age_gated": false, + "direct_lending": 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": [ + "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, + "subscriber_opt_in": true, + "age_gated": false, + "direct_lending": 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." + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5276,10 +8656,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUsAppToPerson", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchUsAppToPerson" }, "post": { "description": "", @@ -5318,6 +8695,93 @@ "application/json": { "schema": { "$ref": "#/components/schemas/messaging.v1.service.us_app_to_person" + }, + "examples": { + "update": { + "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" + } + }, + "subscriber_opt_in": false, + "age_gated": false, + "direct_lending": false, + "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", + "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.", + "opt_in_keywords": [ + "START" + ], + "opt_out_keywords": [ + "STOP" + ], + "help_keywords": [ + "HELP" + ], + "help_message": "Acme Corporation: Please visit www.example.com to get support. To opt-out, reply STOP.", + "mock": false, + "errors": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5330,9 +8794,6 @@ } ], "operationId": "UpdateUsAppToPerson", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5381,6 +8842,22 @@ "AgeGated", "DirectLending" ] + }, + "examples": { + "update": { + "value": { + "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" + ], + "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.", + "HasEmbeddedLinks": true, + "HasEmbeddedPhone": false, + "AgeGated": false, + "DirectLending": false + } + } } } } @@ -5398,9 +8875,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": "", @@ -5429,6 +8906,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^BN[0-9a-fA-F]{32}$" + }, + "examples": { + "fetchWithBrandRegistrationSid": { + "value": "BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } } ], @@ -5438,6 +8920,296 @@ "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 + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5449,10 +9221,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUsAppToPersonUsecase", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchUsAppToPersonUsecase" } }, "/v1/Services/Usecases": { @@ -5479,6 +9248,60 @@ "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." + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5490,10 +9313,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUsecase", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchUsecase" } } }, @@ -5539,6 +9359,9 @@ { "name": "MessagingV1LinkshorteningMessagingServiceDomainAssociation" }, + { + "name": "MessagingV1Message" + }, { "name": "MessagingV1PhoneNumber" }, @@ -5559,16 +9382,17 @@ }, { "name": "MessagingV1Usecase" - } - ], - "x-maturity": [ + }, { - "name": "GA", - "description": "This product is Generally Available." + "name": "MessagingV1WhatsappSender" }, { - "name": "Beta", - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." + "name": "MessagingV1WhatsappTemplate" + } + ], + "security": [ + { + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_microvisor_v1.json b/src/services/twilio-api/twilio_microvisor_v1.json index b30373b5..650caaa5 100644 --- a/src/services/twilio-api/twilio_microvisor_v1.json +++ b/src/services/twilio-api/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.56.1" + "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.", @@ -337,16 +337,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -355,21 +357,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" } }, "title": "ListAccountConfigResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -381,10 +460,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAccountConfig", - "x-maturity": [ - "Preview" - ] + "operationId": "ListAccountConfig" }, "post": { "description": "Create a config for an Account.", @@ -397,6 +473,52 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -409,9 +531,6 @@ } ], "operationId": "CreateAccountConfig", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -432,6 +551,14 @@ "Key", "Value" ] + }, + "examples": { + "createAccountConfig": { + "value": { + "Key": "first,", + "Value": "first val" + } + } } } } @@ -444,11 +571,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.", @@ -472,6 +599,52 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -483,10 +656,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAccountConfig", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchAccountConfig" }, "post": { "description": "Update a config for an Account.", @@ -510,6 +680,52 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -522,9 +738,6 @@ } ], "operationId": "UpdateAccountConfig", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -540,6 +753,13 @@ "required": [ "Value" ] + }, + "examples": { + "update": { + "value": { + "Value": "place" + } + } } } } @@ -571,10 +791,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteAccountConfig", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteAccountConfig" } }, "/v1/Secrets": { @@ -583,11 +800,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.", @@ -637,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" @@ -655,21 +874,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" } }, "title": "ListAccountSecretResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -681,10 +975,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAccountSecret", - "x-maturity": [ - "Preview" - ] + "operationId": "ListAccountSecret" }, "post": { "description": "Create a secret for an Account.", @@ -697,6 +988,51 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -709,9 +1045,6 @@ } ], "operationId": "CreateAccountSecret", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -732,6 +1065,14 @@ "Key", "Value" ] + }, + "examples": { + "createAccountSecret": { + "value": { + "Key": "first,", + "Value": "first val" + } + } } } } @@ -744,11 +1085,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.", @@ -772,6 +1113,51 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -783,10 +1169,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAccountSecret", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchAccountSecret" }, "post": { "description": "Update a secret for an Account.", @@ -810,6 +1193,51 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -822,9 +1250,6 @@ } ], "operationId": "UpdateAccountSecret", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -840,6 +1265,13 @@ "required": [ "Value" ] + }, + "examples": { + "update": { + "value": { + "Value": "place" + } + } } } } @@ -871,10 +1303,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteAccountSecret", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteAccountSecret" } }, "/v1/Apps": { @@ -883,13 +1312,12 @@ "url": "https://microvisor.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name" ], - "pathType": "list", "dependentProperties": { "app_manifests": { "mapping": { @@ -897,7 +1325,8 @@ }, "resource_url": "/v1/Apps/{app_sid}/Manifest" } - } + }, + "pathType": "list" }, "get": { "description": "Retrieve a list of all Apps for an Account.", @@ -947,16 +1376,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "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,21 +1396,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" } }, "title": "ListAppResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -991,10 +1499,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListApp", - "x-maturity": [ - "Preview" - ] + "operationId": "ListApp" } }, "/v1/Apps/{Sid}": { @@ -1003,13 +1508,12 @@ "url": "https://microvisor.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name" ], - "pathType": "instance", "dependentProperties": { "app_manifests": { "mapping": { @@ -1017,7 +1521,8 @@ }, "resource_url": "/v1/Apps/{app_sid}/Manifest" } - } + }, + "pathType": "instance" }, "get": { "description": "Fetch a specific App.", @@ -1041,6 +1546,58 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1052,10 +1609,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchApp", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchApp" }, "delete": { "description": "Delete a specific App.", @@ -1083,10 +1637,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteApp", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteApp" } }, "/v1/Apps/{AppSid}/Manifest": { @@ -1095,12 +1646,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.", @@ -1124,6 +1675,52 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1135,10 +1732,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAppManifest", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchAppManifest" } }, "/v1/Devices": { @@ -1147,13 +1741,12 @@ "url": "https://microvisor.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name" ], - "pathType": "list", "dependentProperties": { "device_configs": { "mapping": { @@ -1167,7 +1760,8 @@ }, "resource_url": "/v1/Devices/{device_sid}/Secrets" } - } + }, + "pathType": "list" }, "get": { "description": "Retrieve a list of all Devices registered with the Account.", @@ -1217,16 +1811,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1235,21 +1831,111 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListDeviceResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1261,10 +1947,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListDevice", - "x-maturity": [ - "Preview" - ] + "operationId": "ListDevice" } }, "/v1/Devices/{Sid}": { @@ -1273,13 +1956,12 @@ "url": "https://microvisor.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name" ], - "pathType": "instance", "dependentProperties": { "device_configs": { "mapping": { @@ -1293,7 +1975,8 @@ }, "resource_url": "/v1/Devices/{device_sid}/Secrets" } - } + }, + "pathType": "instance" }, "get": { "description": "Fetch a specific Device.", @@ -1317,6 +2000,71 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1328,10 +2076,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDevice", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchDevice" }, "post": { "description": "Update a specific Device.", @@ -1355,6 +2100,98 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1367,9 +2204,6 @@ } ], "operationId": "UpdateDevice", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1394,12 +2228,23 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -1409,12 +2254,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.", @@ -1473,16 +2318,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1491,21 +2338,100 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListDeviceConfigResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1517,10 +2443,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListDeviceConfig", - "x-maturity": [ - "Preview" - ] + "operationId": "ListDeviceConfig" }, "post": { "description": "Create a config for a Microvisor Device.", @@ -1544,6 +2467,53 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1556,9 +2526,6 @@ } ], "operationId": "CreateDeviceConfig", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1579,6 +2546,14 @@ "Key", "Value" ] + }, + "examples": { + "createAccountConfig": { + "value": { + "Key": "first,", + "Value": "first val" + } + } } } } @@ -1591,12 +2566,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.", @@ -1629,6 +2604,53 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1640,10 +2662,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDeviceConfig", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchDeviceConfig" }, "post": { "description": "Update a config for a Microvisor Device.", @@ -1676,6 +2695,53 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1688,9 +2754,6 @@ } ], "operationId": "UpdateDeviceConfig", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1706,6 +2769,13 @@ "required": [ "Value" ] + }, + "examples": { + "update": { + "value": { + "Value": "place" + } + } } } } @@ -1746,10 +2816,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteDeviceConfig", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteDeviceConfig" } }, "/v1/Devices/{DeviceSid}/Secrets": { @@ -1758,12 +2825,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.", @@ -1822,16 +2889,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1840,21 +2909,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" } }, "title": "ListDeviceSecretResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1866,10 +3012,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListDeviceSecret", - "x-maturity": [ - "Preview" - ] + "operationId": "ListDeviceSecret" }, "post": { "description": "Create a secret for a Microvisor Device.", @@ -1893,6 +3036,52 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1905,9 +3094,6 @@ } ], "operationId": "CreateDeviceSecret", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1928,6 +3114,14 @@ "Key", "Value" ] + }, + "examples": { + "createAccountSecret": { + "value": { + "Key": "first,", + "Value": "first val" + } + } } } } @@ -1940,12 +3134,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.", @@ -1978,6 +3172,52 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1989,10 +3229,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDeviceSecret", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchDeviceSecret" }, "post": { "description": "Update a secret for a Microvisor Device.", @@ -2025,6 +3262,52 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2037,9 +3320,6 @@ } ], "operationId": "UpdateDeviceSecret", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2055,6 +3335,13 @@ "required": [ "Value" ] + }, + "examples": { + "update": { + "value": { + "Value": "place" + } + } } } } @@ -2095,10 +3382,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteDeviceSecret", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteDeviceSecret" } } }, @@ -2120,20 +3404,28 @@ { "name": "MicrovisorV1AppManifest" }, + { + "name": "MicrovisorV1DebugToken" + }, { "name": "MicrovisorV1Device" }, + { + "name": "MicrovisorV1DeviceCert" + }, { "name": "MicrovisorV1DeviceConfig" }, { "name": "MicrovisorV1DeviceSecret" + }, + { + "name": "MicrovisorV1LoggingToken" } ], - "x-maturity": [ + "security": [ { - "name": "Preview", - "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact https://www.twilio.com/help/contact." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_monitor_v1.json b/src/services/twilio-api/twilio_monitor_v1.json index d4683f5a..667e1431 100644 --- a/src/services/twilio-api/twilio_monitor_v1.json +++ b/src/services/twilio-api/twilio_monitor_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "monitor.v1.alert": { "type": "object", @@ -312,12 +318,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -333,7 +333,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -378,6 +378,67 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -389,10 +450,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAlert", - "x-maturity": [ - "GA" - ] + "operationId": "FetchAlert" } }, "/v1/Alerts": { @@ -423,6 +481,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" + } } }, { @@ -432,6 +498,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readEmpty": { + "value": "2016-01-01" + }, + "readFull": { + "value": "2016-01-01" + } } }, { @@ -441,6 +515,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readEmpty": { + "value": "2016-01-01" + }, + "readFull": { + "value": "2016-01-01" + } } }, { @@ -485,16 +567,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -503,21 +587,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" } }, "title": "ListAlertResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -529,10 +695,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAlert", - "x-maturity": [ - "GA" - ] + "operationId": "ListAlert" } }, "/v1/Events/{Sid}": { @@ -576,6 +739,70 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -587,10 +814,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEvent", - "x-maturity": [ - "GA" - ] + "operationId": "FetchEvent" } }, "/v1/Events": { @@ -624,6 +848,14 @@ "minLength": 34, "maxLength": 34, "pattern": "^US[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -632,6 +864,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" + } } }, { @@ -643,6 +883,14 @@ "minLength": 34, "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -651,6 +899,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" + } } }, { @@ -660,6 +916,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFull": { + "value": "2008-01-02" + }, + "readEmpty": { + "value": "2008-01-02" + } } }, { @@ -669,6 +933,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFull": { + "value": "2008-01-02" + }, + "readEmpty": { + "value": "2008-01-02" + } } }, { @@ -713,16 +985,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -731,21 +1005,110 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListEventResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -757,10 +1120,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListEvent", - "x-maturity": [ - "GA" - ] + "operationId": "ListEvent" } } }, @@ -777,10 +1137,9 @@ "name": "MonitorV1Event" } ], - "x-maturity": [ + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_notify_v1.json b/src/services/twilio-api/twilio_notify_v1.json index 97e8c645..f1c8d5a7 100644 --- a/src/services/twilio-api/twilio_notify_v1.json +++ b/src/services/twilio-api/twilio_notify_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "notify.v1.service.binding": { "type": "object", @@ -456,12 +462,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" + ] } } }, @@ -478,7 +489,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -488,7 +499,7 @@ "url": "https://notify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -497,8 +508,8 @@ "binding_type", "address" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -537,6 +548,66 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -548,10 +619,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchBinding", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchBinding" }, "delete": { "description": "", @@ -594,10 +662,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteBinding", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteBinding" } }, "/v1/Services/{ServiceSid}/Bindings": { @@ -606,7 +671,7 @@ "url": "https://notify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -615,8 +680,8 @@ "binding_type", "address" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -643,6 +708,66 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -655,9 +780,6 @@ } ], "operationId": "CreateBinding", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -706,6 +828,21 @@ "BindingType", "Address" ] + }, + "examples": { + "create": { + "value": { + "Address": "address", + "BindingType": "apn", + "CredentialSid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Endpoint": "endpoint", + "Identity": "24987039", + "NotificationProtocolVersion": "notification_protocol_version", + "Tag": [ + "tag" + ] + } + } } } } @@ -762,6 +899,18 @@ "handling": "standard", "deleteSla": 120 } + }, + "examples": { + "readEmpty": { + "value": [ + "identity" + ] + }, + "readFull": { + "value": [ + "identity" + ] + } } }, { @@ -773,6 +922,18 @@ "items": { "type": "string" } + }, + "examples": { + "readEmpty": { + "value": [ + "tag" + ] + }, + "readFull": { + "value": [ + "tag" + ] + } } }, { @@ -817,16 +978,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -835,21 +998,106 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListBindingResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -861,10 +1109,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListBinding", - "x-maturity": [ - "Beta" - ] + "operationId": "ListBinding" } }, "/v1/Credentials": { @@ -873,7 +1118,7 @@ "url": "https://notify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -930,16 +1175,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "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,21 +1195,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" } }, "title": "ListCredentialResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -974,10 +1296,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCredential", - "x-maturity": [ - "Beta" - ] + "operationId": "ListCredential" }, "post": { "description": "", @@ -990,6 +1309,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1002,9 +1371,6 @@ } ], "operationId": "CreateCredential", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1045,6 +1411,13 @@ "required": [ "Type" ] + }, + "examples": { + "create": { + "value": { + "Type": "apn" + } + } } } } @@ -1057,7 +1430,7 @@ "url": "https://notify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -1091,6 +1464,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1102,10 +1525,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCredential", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchCredential" }, "post": { "description": "", @@ -1132,6 +1552,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1144,9 +1614,6 @@ } ], "operationId": "UpdateCredential", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1179,12 +1646,16 @@ "description": "[FCM only] The `Server key` of your project from Firebase console under Settings / Cloud messaging." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "Test slow create" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -1216,10 +1687,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCredential", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteCredential" } }, "/v1/Services/{ServiceSid}/Notifications": { @@ -1228,15 +1696,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": "", @@ -1263,6 +1731,94 @@ "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1275,9 +1831,6 @@ } ], "operationId": "CreateNotification", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1364,6 +1917,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" + } + } } } } @@ -1374,8 +1944,7 @@ "identity", "tag" ] - ], - "addContentTypeIfEmptyForm": true + ] } } }, @@ -1385,14 +1954,13 @@ "url": "https://notify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { "bindings": { "mapping": { @@ -1418,7 +1986,8 @@ }, "resource_url": "/v1/Services/{service_sid}/Segments" } - } + }, + "pathType": "list" }, "post": { "description": "", @@ -1431,6 +2000,74 @@ "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": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1443,9 +2080,6 @@ } ], "operationId": "CreateService", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1522,12 +2156,27 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -1586,16 +2235,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1604,21 +2255,114 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListServiceResponse" + }, + "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": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1630,10 +2374,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListService", - "x-maturity": [ - "Beta" - ] + "operationId": "ListService" } }, "/v1/Services/{Sid}": { @@ -1642,14 +2383,13 @@ "url": "https://notify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { "bindings": { "mapping": { @@ -1675,7 +2415,8 @@ }, "resource_url": "/v1/Services/{service_sid}/Segments" } - } + }, + "pathType": "instance" }, "delete": { "description": "", @@ -1706,10 +2447,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteService", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteService" }, "get": { "description": "", @@ -1736,6 +2474,74 @@ "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": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1747,10 +2553,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchService", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchService" }, "post": { "description": "", @@ -1777,6 +2580,74 @@ "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": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1789,9 +2660,6 @@ } ], "operationId": "UpdateService", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1868,12 +2736,27 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } } @@ -1893,14 +2776,25 @@ { "name": "NotifyV1Notification" }, + { + "name": "NotifyV1Segment" + }, + { + "name": "NotifyV1SegmentMembership" + }, { "name": "NotifyV1Service" + }, + { + "name": "NotifyV1User" + }, + { + "name": "NotifyV1UserBinding" } ], - "x-maturity": [ + "security": [ { - "name": "Beta", - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_numbers_v1.json b/src/services/twilio-api/twilio_numbers_v1.json index 3669f4a8..c01a433f 100644 --- a/src/services/twilio-api/twilio_numbers_v1.json +++ b/src/services/twilio-api/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": { @@ -100,6 +138,28 @@ "eligible" ] }, + "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_port_in": { "type": "object", "properties": { @@ -171,6 +231,11 @@ }, "nullable": true, "description": "The list of documents SID referencing a utility bills" + }, + "date_created": { + "type": "string", + "format": "date", + "nullable": true } } }, @@ -228,7 +293,7 @@ "nullable": true, "description": "The phone number is missing required fields." }, - "status_last_time_updated_timestamp": { + "last_updated": { "type": "string", "format": "date-time", "nullable": true, @@ -251,7 +316,7 @@ "description": "The reason why the phone number is not portable." }, "not_portability_reason_code": { - "type": "string", + "type": "integer", "nullable": true, "description": "The code of the reason why the phone number is not portable." }, @@ -259,6 +324,21 @@ "type": "string", "nullable": true, "description": "The status of the phone number in the port in request." + }, + "port_out_pin": { + "type": "integer", + "nullable": true, + "description": "The pin required for the losing carrier to port out the phone number." + }, + "rejection_reason": { + "type": "string", + "nullable": true, + "description": "The rejection reason returned by the vendor." + }, + "rejection_reason_code": { + "type": "integer", + "nullable": true, + "description": "The rejection reason code returned by the vendor." } } }, @@ -311,16 +391,6 @@ "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", @@ -485,12 +555,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -506,7 +570,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -516,11 +580,95 @@ "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.", + "tags": [ + "NumbersV1BulkEligibility" + ], + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "Accepted" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateBulkEligibility", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "CreateBulkEligibilityRequest", + "properties": {} + } + } + } + } } }, "/v1/HostedNumber/Eligibility/Bulk/{RequestId}": { @@ -529,11 +677,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.", @@ -560,6 +708,72 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -571,10 +785,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchBulkEligibility", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchBulkEligibility" } }, "/v1/HostedNumber/Eligibility": { @@ -583,11 +794,122 @@ "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.", + "tags": [ + "NumbersV1Eligibility" + ], + "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 + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateEligibility", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "CreateEligibilityRequest", + "properties": {} + } + } + } + } } }, "/v1/Porting/PortIn": { @@ -596,13 +918,132 @@ "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "port_in_request_sid" ], - "pathType": "list", - "mountName": "porting_port_ins" + "mountName": "porting_port_ins", + "pathType": "list" + }, + "post": { + "description": "Allows to create a new port in request", + "tags": [ + "NumbersV1PortingPortIn" + ], + "responses": { + "202": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/numbers.v1.porting_port_in" + }, + "examples": { + "create": { + "value": { + "port_in_request_sid": "KWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "notification_emails": [ + "user@domain.com" + ], + "target_port_in_date": "2023-09-10", + "target_port_in_time_range_start": "10:00:00+01:00", + "target_port_in_time_range_end": "20:00:00+01:00", + "port_in_request_status": "pending", + "date_created": "2023-09-10", + "losing_carrier_information": { + "customer_type": "Business/Individual", + "customer_name": "Customer name for carrier", + "authorized_representative": "John Smith", + "authorized_representative_email": "signer@domain.com", + "account_number": "123456", + "account_telephone_number": "+133232323", + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address": { + "street": "Your Street", + "street_2": "Other Street or null", + "city": "City", + "state": "State", + "zip": "000000", + "country": "US" + } + }, + "phone_numbers": [ + { + "phone_number": "+16175551212", + "pin": "123456", + "portable": true, + "not_portability_reason": "string", + "port_in_phone_number_sid": "PUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "port_in_phone_number_status": "In Review", + "not_portability_reason_code": 0 + } + ], + "documents": [ + "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "url": "https://numbers.twilio.com/v1/Porting/PortIn/KWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "Accepted" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreatePortingPortIn", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "CreatePortingPortInRequest", + "properties": {} + } + } + } + } } }, "/v1/Porting/PortIn/{PortInRequestSid}": { @@ -611,13 +1052,13 @@ "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "port_in_request_sid" ], - "pathType": "instance", - "mountName": "porting_port_ins" + "mountName": "porting_port_ins", + "pathType": "instance" }, "delete": { "description": "Allows to cancel a port in request by SID", @@ -648,10 +1089,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeletePortingPortIn", - "x-maturity": [ - "Beta" - ] + "operationId": "DeletePortingPortIn" }, "get": { "description": "Fetch a port in request by SID", @@ -678,6 +1116,90 @@ "application/json": { "schema": { "$ref": "#/components/schemas/numbers.v1.porting_port_in" + }, + "examples": { + "fetch": { + "value": { + "port_in_request_sid": "KWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://numbers.twilio.com/v1/Porting/PortIn/KWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "notification_emails": [ + "user@domain.com" + ], + "target_port_in_date": "2023-09-10", + "target_port_in_time_range_start": "10:00:00+01:00", + "target_port_in_time_range_end": "20:00:00+01:00", + "port_in_request_status": "pending", + "date_created": "2023-09-10", + "losing_carrier_information": { + "customer_type": "Business/Individual", + "customer_name": "Customer name for carrier", + "authorized_representative": "John Smith", + "authorized_representative_email": "signer@domain.com", + "account_number": "123456", + "account_telephone_number": "+133232323", + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address": { + "street": "Your Street", + "street_2": "Other Street or null", + "city": "City", + "state": "State", + "zip": "000000", + "country": "US" + } + }, + "phone_numbers": [ + { + "phone_number": "+16175551212", + "pin": "123456", + "portable": true, + "not_portability_reason": "string", + "not_portability_reason_code": 0, + "port_in_phone_number_sid": "PUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "port_in_phone_number_status": "In Review" + } + ], + "documents": [ + "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -689,10 +1211,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchPortingPortIn", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchPortingPortIn" } }, "/v1/Porting/PortIn/{PortInRequestSid}/PhoneNumber/{PhoneNumberSid}": { @@ -701,14 +1220,14 @@ "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "port_in_request_sid", "phone_number_sid" ], - "pathType": "instance", - "mountName": "porting_port_in_phone_number" + "mountName": "porting_port_in_phone_number", + "pathType": "instance" }, "delete": { "description": "Allows to cancel a port in request phone number by SID", @@ -751,10 +1270,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeletePortingPortInPhoneNumber", - "x-maturity": [ - "Beta" - ] + "operationId": "DeletePortingPortInPhoneNumber" }, "get": { "description": "Fetch a phone number by port in request SID and phone number SID", @@ -793,6 +1309,65 @@ "application/json": { "schema": { "$ref": "#/components/schemas/numbers.v1.porting_port_in_phone_number" + }, + "examples": { + "fetch": { + "value": { + "port_in_request_sid": "KWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "phone_number_type": "LOCAL", + "date_created": "2024-04-10T06:52:21Z", + "country": "US", + "missing_required_fields": false, + "last_updated": "2024-03-12T06:52:21Z", + "phone_number": "+15024953384", + "portable": true, + "not_portability_reason": "ALREADY_IN_TWILIO_DIFFERENT_OWNER", + "not_portability_reason_code": 22132, + "port_in_phone_number_status": "in_review", + "phone_number_sid": "PUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "port_out_pin": 1234, + "rejection_reason": null, + "rejection_reason_code": null, + "url": "https://numbers.twilio.com/v1/Porting/PortIn/KWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumber/PUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -804,10 +1379,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchPortingPortInPhoneNumber", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchPortingPortInPhoneNumber" } }, "/v1/Porting/Portability/PhoneNumber/{PhoneNumber}": { @@ -816,11 +1388,11 @@ "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "mountName": "porting_portabilities" + "mountName": "porting_portabilities", + "pathType": "instance" }, "get": { "description": "Allows to check if a single phone number can be ported to Twilio or not.", @@ -847,6 +1419,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$" + }, + "examples": { + "fetch": { + "value": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02" + } } } ], @@ -856,6 +1433,57 @@ "application/json": { "schema": { "$ref": "#/components/schemas/numbers.v1.porting_portability" + }, + "examples": { + "fetch": { + "value": { + "phone_number": "+18001234567", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa01", + "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", + "url": "https://numbers.twilio.com/v1/Porting/Portability/PhoneNumber/+18001234567" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -867,10 +1495,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchPortingPortability", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchPortingPortability" } }, "/v1/Porting/Configuration/Webhook": { @@ -879,11 +1504,106 @@ "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], + "mountName": "porting_webhook_configurations", "pathType": "list" }, + "post": { + "description": "Allows to create a new webhook configuration", + "tags": [ + "NumbersV1PortingWebhookConfiguration" + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/numbers.v1.porting_webhook_configuration" + }, + "examples": { + "create": { + "value": { + "port_in_target_url": "https://www.example.com/port-in", + "port_out_target_url": "https://www.example.com/port-out", + "notifications_of": [ + "PortInWaitingForSignature", + "PortInInProgress", + "PortInCompleted", + "PortInActionRequired", + "PortInCanceled", + "PortInExpired", + "PortInPhoneNumberWaitingForSignature", + "PortInPhoneNumberSubmitted", + "PortInPhoneNumberPending", + "PortInPhoneNumberCompleted", + "PortInPhoneNumberRejected", + "PortOutPhoneNumberCompleted" + ], + "url": "https://numbers.twilio.com/v1/Porting/Configuration/Webhook" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreatePortingWebhookConfiguration", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "CreatePortingWebhookConfigurationRequest", + "properties": {} + } + } + } + } + }, "get": { "description": "Allows to fetch the webhook configuration", "tags": [ @@ -895,6 +1615,67 @@ "application/json": { "schema": { "$ref": "#/components/schemas/numbers.v1.porting_webhook_configuration_fetch" + }, + "examples": { + "fetch": { + "value": { + "port_in_target_url": "https://www.example.com/port-in", + "port_out_target_url": "https://www.example.com/port-out", + "notifications_of": [ + "PortInWaitingForSignature", + "PortInInProgress", + "PortInCompleted", + "PortInActionRequired", + "PortInCanceled", + "PortInExpired", + "PortInPhoneNumberWaitingForSignature", + "PortInPhoneNumberSubmitted", + "PortInPhoneNumberPending", + "PortInPhoneNumberCompleted", + "PortInPhoneNumberRejected", + "PortOutPhoneNumberCompleted" + ], + "port_in_target_date_created": "2024-05-14T13:49:04Z", + "port_out_target_date_created": "2024-05-14T13:49:07Z", + "url": "https://numbers.twilio.com/v1/Porting/Configuration/Webhook" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -907,9 +1688,9 @@ } ], "operationId": "FetchPortingWebhookConfigurationFetch", - "x-maturity": [ - "Beta" - ] + "x-twilio": { + "mountName": "porting_webhook_configuration_fetch" + } } }, "/v1/Porting/Configuration/Webhook/{WebhookType}": { @@ -918,12 +1699,12 @@ "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", "mountName": "porting_webhook_configurations_delete", - "className": "porting_webhook_configuration_delete" + "className": "porting_webhook_configuration_delete", + "pathType": "instance" }, "delete": { "description": "Allows the client to delete a webhook configuration.", @@ -952,10 +1733,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeletePortingWebhookConfigurationDelete", - "x-maturity": [ - "Beta" - ] + "operationId": "DeletePortingWebhookConfigurationDelete" } }, "/v1/SigningRequest/Configuration": { @@ -964,15 +1742,100 @@ "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "product", "email_subject", "email_message" ], - "pathType": "list", - "mountName": "signing_request_configurations" + "mountName": "signing_request_configurations", + "pathType": "list" + }, + "post": { + "description": "Synchronous operation to insert or update a configuration for the customer.", + "tags": [ + "NumbersV1SigningRequestConfiguration" + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/numbers.v1.signing_request_configuration" + }, + "examples": { + "create": { + "value": { + "logo_sid": "RD00000000000000000000000000000000", + "friendly_name": "Configuration", + "product": "Porting", + "country": "US", + "email_subject": "Twilio Porting Request", + "email_message": "This is a signature request from Twilio, please check the document and sign it", + "url_redirection": "https://www.twilio.com/redirect-url", + "url": "https://numbers.twilio.com/v1/SigningRequest/Configuration" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateSigningRequestConfiguration", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "CreateSigningRequestConfigurationRequest", + "properties": {} + } + } + } + } } } }, @@ -982,9 +1845,27 @@ } ], "tags": [ + { + "name": "NumbersV1AuthorizationDocument" + }, { "name": "NumbersV1BulkEligibility" }, + { + "name": "NumbersV1DependentOrder" + }, + { + "name": "NumbersV1Documents" + }, + { + "name": "NumbersV1Eligibility" + }, + { + "name": "NumbersV1HostedNumberOrder" + }, + { + "name": "NumbersV1Identity" + }, { "name": "NumbersV1PortingPortIn" }, @@ -994,17 +1875,25 @@ { "name": "NumbersV1PortingPortability" }, + { + "name": "NumbersV1PortingWebhookConfiguration" + }, { "name": "NumbersV1PortingWebhookConfigurationDelete" }, { "name": "NumbersV1PortingWebhookConfigurationFetch" + }, + { + "name": "NumbersV1ProofOfAddress" + }, + { + "name": "NumbersV1SigningRequestConfiguration" } ], - "x-maturity": [ + "security": [ { - "name": "Beta", - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_numbers_v2.json b/src/services/twilio-api/twilio_numbers_v2.json index 2acd56bb..2233d19a 100644 --- a/src/services/twilio-api/twilio_numbers_v2.json +++ b/src/services/twilio-api/twilio_numbers_v2.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "numbers.v2.authorization_document": { "type": "object", @@ -1193,12 +1199,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -1214,7 +1214,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -1224,10 +1224,9 @@ "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", "dependentProperties": { "dependent_hosted_number_orders": { "mapping": { @@ -1235,7 +1234,8 @@ }, "resource_url": "/v2/HostedNumber/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders" } - } + }, + "pathType": "instance" }, "get": { "description": "Fetch a specific AuthorizationDocument.", @@ -1262,6 +1262,62 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1273,10 +1329,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAuthorizationDocument", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchAuthorizationDocument" }, "delete": { "description": "Cancel the AuthorizationDocument request.", @@ -1307,10 +1360,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteAuthorizationDocument", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteAuthorizationDocument" } }, "/v2/HostedNumber/AuthorizationDocuments": { @@ -1319,10 +1369,9 @@ "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "dependentProperties": { "dependent_hosted_number_orders": { "mapping": { @@ -1330,7 +1379,8 @@ }, "resource_url": "/v2/HostedNumber/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders" } - } + }, + "pathType": "list" }, "get": { "description": "Retrieve a list of AuthorizationDocuments belonging to the account initiating the request.", @@ -1350,6 +1400,11 @@ "handling": "standard", "deleteSla": 30 } + }, + "examples": { + "readEmpty": { + "value": "test+hosted@twilio.com" + } } }, { @@ -1359,6 +1414,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/authorization_document_enum_status" + }, + "examples": { + "readEmpty": { + "value": "signed" + } } }, { @@ -1403,16 +1463,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1421,21 +1483,102 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListAuthorizationDocumentResponse" + }, + "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" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1447,10 +1590,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAuthorizationDocument", - "x-maturity": [ - "Beta" - ] + "operationId": "ListAuthorizationDocument" }, "post": { "description": "Create an AuthorizationDocument for authorizing the hosting of phone number capabilities on Twilio's platform.", @@ -1463,6 +1603,62 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1475,9 +1671,6 @@ } ], "operationId": "CreateAuthorizationDocument", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1526,6 +1719,24 @@ "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" + } + } } } } @@ -1538,11 +1749,11 @@ "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "mountName": "bulk_hosted_number_orders" + "mountName": "bulk_hosted_number_orders", + "pathType": "instance" }, "get": { "description": "Fetch a specific BulkHostedNumberOrder.", @@ -1577,6 +1788,112 @@ "application/json": { "schema": { "$ref": "#/components/schemas/numbers.v2.bulk_hosted_number_order" + }, + "examples": { + "fetchNoParams": { + "value": { + "friendly_name": "test", + "bulk_hosting_sid": "BHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "notification_email": "test@twilio.com", + "request_status": "PROCESSED", + "url": "https://numbers.twilio.com/v2/HostedNumber/Orders/Bulk/BHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2023-06-29T15:19:37Z", + "date_completed": "2023-06-30T15:19:37Z", + "total_count": 4, + "results": [ + { + "order_status": "pending_loa", + "count": "2", + "get_more_info": null, + "orders": [ + { + "hosting_order_sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "phone_number": "+12222222222", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "failure_reason": null, + "next_step": null, + "url": "https://numbers.twilio.com/v2/HostedNumber/Orders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "email": "test@twilio.com", + "signing_document_sid": "PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + { + "hosting_order_sid": "HRbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "phone_number": "+13333333333", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "failure_reason": null, + "next_step": null, + "url": "https://numbers.twilio.com/v2/HostedNumber/Orders/HRbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", + "email": "test@twilio.com", + "signing_document_sid": "PXbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" + } + ] + }, + { + "order_status": "failed", + "count": "2", + "get_more_info": "For more information, call the Hosted Number Eligibility API: https://www.twilio.com/docs/phone-numbers/hosted-numbers-api/eligibility-api-overview", + "orders": [ + { + "hosting_order_sid": "HRcccccccccccccccccccccccccccccccc", + "phone_number": "+14444444444", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "failure_reason": "test failure-reason", + "next_step": "test next-step", + "url": "https://numbers.twilio.com/v2/HostedNumber/Orders/HRcccccccccccccccccccccccccccccccc", + "email": "test@twilio.com", + "signing_document_sid": null + }, + { + "hosting_order_sid": "HRdddddddddddddddddddddddddddddddd", + "phone_number": "+15555555555", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "failure_reason": "test failure-reason", + "next_step": "test next-step", + "url": "https://numbers.twilio.com/v2/HostedNumber/Orders/HRdddddddddddddddddddddddddddddddd", + "email": "test@twilio.com", + "signing_document_sid": null + } + ] + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1588,10 +1905,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchBulkHostedNumberOrder", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchBulkHostedNumberOrder" } }, "/v2/HostedNumber/Orders/Bulk": { @@ -1600,11 +1914,97 @@ "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "mountName": "bulk_hosted_number_orders" + "mountName": "bulk_hosted_number_orders", + "pathType": "list" + }, + "post": { + "description": "Host multiple phone numbers on Twilio's platform.", + "tags": [ + "NumbersV2BulkHostedNumberOrder" + ], + "responses": { + "202": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/numbers.v2.bulk_hosted_number_order" + }, + "examples": { + "create": { + "value": { + "friendly_name": "test", + "bulk_hosting_sid": "BHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "request_status": "QUEUED", + "notification_email": "test@twilio.com", + "url": "https://numbers.twilio.com/v2/HostedNumber/Orders/Bulk/BHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2023-06-29T15:19:37Z", + "date_completed": null, + "total_count": 4, + "results": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "Accepted" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateBulkHostedNumberOrder", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "CreateBulkHostedNumberOrderRequest", + "properties": {} + } + } + } + } } }, "/v2/RegulatoryCompliance/Bundles": { @@ -1613,14 +2013,13 @@ "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "regulation_sid", "friendly_name" ], - "pathType": "list", "dependentProperties": { "evaluations": { "mapping": { @@ -1647,7 +2046,8 @@ "resource_url": "/v2/RegulatoryCompliance/Bundles/{bundle_sid}/ReplaceItems" } }, - "parent": "/RegulatoryCompliance" + "parent": "/RegulatoryCompliance", + "pathType": "list" }, "post": { "description": "Create a new Bundle.", @@ -1660,6 +2060,64 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1672,9 +2130,6 @@ } ], "operationId": "CreateBundle", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1720,6 +2175,16 @@ "FriendlyName", "Email" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "Email": "email", + "RegulationSid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "StatusCallback": "http://www.example.com" + } + } } } } @@ -1738,6 +2203,20 @@ "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" + } } }, { @@ -1746,6 +2225,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" + } } }, { @@ -1757,6 +2241,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^RN[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -1765,6 +2254,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" + } } }, { @@ -1773,6 +2276,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" + } } }, { @@ -1781,6 +2298,11 @@ "description": "Indicates that the Bundle is a valid Bundle until a specified expiration date.", "schema": { "type": "boolean" + }, + "examples": { + "readApprovedAuMobileWithDate": { + "value": "true" + } } }, { @@ -1817,6 +2339,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readApprovedAuMobileDateLess": { + "value": "2022-11-29T23:59:59Z" + }, + "readApprovedJapanTollfreeDateBetween": { + "value": "2022-11-29T23:59:59Z" + } } }, { @@ -1826,6 +2356,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readApprovedJapanTollfreeDateBetween": { + "value": "2022-01-01T00:00:00Z" + } } }, { @@ -1870,16 +2405,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1888,36 +2425,215 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListBundleResponse" + }, + "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": [] - } + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } ], - "operationId": "ListBundle", - "x-maturity": [ - "GA" - ] + "operationId": "ListBundle" } }, "/v2/RegulatoryCompliance/Bundles/{Sid}": { @@ -1926,14 +2642,13 @@ "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "regulation_sid", "friendly_name" ], - "pathType": "instance", "dependentProperties": { "evaluations": { "mapping": { @@ -1960,7 +2675,8 @@ "resource_url": "/v2/RegulatoryCompliance/Bundles/{bundle_sid}/ReplaceItems" } }, - "parent": "/RegulatoryCompliance" + "parent": "/RegulatoryCompliance", + "pathType": "instance" }, "get": { "description": "Fetch a specific Bundle instance.", @@ -1987,6 +2703,64 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1998,10 +2772,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchBundle", - "x-maturity": [ - "GA" - ] + "operationId": "FetchBundle" }, "post": { "description": "Updates a Bundle in an account.", @@ -2028,6 +2799,64 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2040,9 +2869,6 @@ } ], "operationId": "UpdateBundle", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2069,12 +2895,19 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -2106,10 +2939,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteBundle", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteBundle" } }, "/v2/RegulatoryCompliance/Bundles/{BundleSid}/Copies": { @@ -2118,12 +2948,12 @@ "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "parent": "/RegulatoryCompliance/Bundles/{Sid}", - "mountName": "bundle_copies" + "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", @@ -2150,6 +2980,58 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2162,9 +3044,6 @@ } ], "operationId": "CreateBundleCopy", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2177,12 +3056,16 @@ "description": "The string that you assigned to describe the copied bundle." } } + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -2245,16 +3128,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "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,21 +3148,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" } }, "title": "ListBundleCopyResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2289,10 +3251,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListBundleCopy", - "x-maturity": [ - "Beta" - ] + "operationId": "ListBundleCopy" } }, "/v2/HostedNumber/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders": { @@ -2301,11 +3260,11 @@ "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "parent": "/HostedNumber/AuthorizationDocuments/{Sid}" + "parent": "/HostedNumber/AuthorizationDocuments/{Sid}", + "pathType": "list" }, "get": { "description": "Retrieve a list of dependent HostedNumberOrders belonging to the AuthorizationDocument.", @@ -2332,6 +3291,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/dependent_hosted_number_order_enum_status" + }, + "examples": { + "readEmpty": { + "value": "completed" + } } }, { @@ -2341,6 +3305,11 @@ "schema": { "type": "string", "format": "phone-number" + }, + "examples": { + "readEmpty": { + "value": "+19193608000" + } } }, { @@ -2352,6 +3321,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^PN[0-9a-fA-F]{32}$" + }, + "examples": { + "readEmpty": { + "value": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -2366,6 +3340,11 @@ "handling": "standard", "deleteSla": 30 } + }, + "examples": { + "readEmpty": { + "value": "example" + } } }, { @@ -2410,16 +3389,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2428,21 +3409,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" } }, "title": "ListDependentHostedNumberOrderResponse" + }, + "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": "BH11111111111111111111111111111111", + "next_step": "Test" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2454,10 +3526,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListDependentHostedNumberOrder", - "x-maturity": [ - "Beta" - ] + "operationId": "ListDependentHostedNumberOrder" } }, "/v2/RegulatoryCompliance/EndUsers": { @@ -2466,14 +3535,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 End User.", @@ -2486,6 +3555,58 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2498,9 +3619,6 @@ } ], "operationId": "CreateEndUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2525,6 +3643,15 @@ "FriendlyName", "Type" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "Type": "individual", + "Attributes": "{}" + } + } } } } @@ -2578,16 +3705,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2596,21 +3725,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" } }, "title": "ListEndUserResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2622,10 +3828,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListEndUser", - "x-maturity": [ - "GA" - ] + "operationId": "ListEndUser" } }, "/v2/RegulatoryCompliance/EndUsers/{Sid}": { @@ -2634,14 +3837,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 End User Instance.", @@ -2668,6 +3871,58 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2679,10 +3934,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEndUser", - "x-maturity": [ - "GA" - ] + "operationId": "FetchEndUser" }, "post": { "description": "Update an existing End User.", @@ -2709,6 +3961,58 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2721,9 +4025,6 @@ } ], "operationId": "UpdateEndUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2739,12 +4040,17 @@ "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": "{}" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -2776,10 +4082,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteEndUser", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteEndUser" } }, "/v2/RegulatoryCompliance/EndUserTypes": { @@ -2788,14 +4091,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 End-User Types.", @@ -2845,16 +4148,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2863,21 +4168,104 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListEndUserTypeResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2889,10 +4277,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListEndUserType", - "x-maturity": [ - "GA" - ] + "operationId": "ListEndUserType" } }, "/v2/RegulatoryCompliance/EndUserTypes/{Sid}": { @@ -2901,14 +4286,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 End-User Type Instance.", @@ -2932,6 +4317,64 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2943,10 +4386,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEndUserType", - "x-maturity": [ - "GA" - ] + "operationId": "FetchEndUserType" } }, "/v2/RegulatoryCompliance/Bundles/{BundleSid}/Evaluations": { @@ -2955,13 +4395,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": "Creates an evaluation for a bundle", @@ -2987,7 +4427,207 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle.evaluation" + "$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" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2999,10 +4639,7 @@ "accountSid_authToken": [] } ], - "operationId": "CreateEvaluation", - "x-maturity": [ - "GA" - ] + "operationId": "CreateEvaluation" }, "get": { "description": "Retrieve a list of Evaluations associated to the Bundle resource.", @@ -3064,16 +4701,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3082,21 +4721,246 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListEvaluationResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3108,10 +4972,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListEvaluation", - "x-maturity": [ - "GA" - ] + "operationId": "ListEvaluation" } }, "/v2/RegulatoryCompliance/Bundles/{BundleSid}/Evaluations/{Sid}": { @@ -3120,13 +4981,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 Evaluation Instance.", @@ -3165,6 +5026,206 @@ "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" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3176,10 +5237,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEvaluation", - "x-maturity": [ - "GA" - ] + "operationId": "FetchEvaluation" } }, "/v2/HostedNumber/Orders/{Sid}": { @@ -3188,11 +5246,11 @@ "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "mountName": "hosted_number_orders" + "mountName": "hosted_number_orders", + "pathType": "instance" }, "get": { "description": "Fetch a specific HostedNumberOrder.", @@ -3219,6 +5277,73 @@ "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": "BH11111111111111111111111111111111", + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3230,10 +5355,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchHostedNumberOrder", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchHostedNumberOrder" }, "delete": { "description": "Cancel the HostedNumberOrder (only available when the status is in `received`).", @@ -3264,10 +5386,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteHostedNumberOrder", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteHostedNumberOrder" } }, "/v2/HostedNumber/Orders": { @@ -3276,11 +5395,11 @@ "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "mountName": "hosted_number_orders" + "mountName": "hosted_number_orders", + "pathType": "list" }, "get": { "description": "Retrieve a list of HostedNumberOrders belonging to the account initiating the request.", @@ -3295,6 +5414,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/hosted_number_order_enum_status" + }, + "examples": { + "readEmpty": { + "value": "completed" + } } }, { @@ -3318,6 +5442,11 @@ "handling": "standard", "deleteSla": 30 } + }, + "examples": { + "readEmpty": { + "value": "+19193608000" + } } }, { @@ -3329,6 +5458,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^PN[0-9a-fA-F]{32}$" + }, + "examples": { + "readEmpty": { + "value": "PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz" + } } }, { @@ -3343,6 +5477,11 @@ "handling": "standard", "deleteSla": 30 } + }, + "examples": { + "readEmpty": { + "value": "example" + } } }, { @@ -3387,16 +5526,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3405,21 +5546,113 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListHostedNumberOrderResponse" + }, + "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": "BH11111111111111111111111111111111", + "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" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3431,10 +5664,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListHostedNumberOrder", - "x-maturity": [ - "Beta" - ] + "operationId": "ListHostedNumberOrder" }, "post": { "description": "Host a phone number's capability on Twilio's platform.", @@ -3447,6 +5677,96 @@ "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": "BH11111111111111111111111111111111", + "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": "BH11111111111111111111111111111111", + "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3459,9 +5779,6 @@ } ], "operationId": "CreateHostedNumberOrder", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3572,6 +5889,25 @@ "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" + } + } } } } @@ -3584,13 +5920,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.", @@ -3617,6 +5953,54 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3629,9 +6013,6 @@ } ], "operationId": "CreateItemAssignment", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3650,6 +6031,13 @@ "required": [ "ObjectSid" ] + }, + "examples": { + "create": { + "value": { + "ObjectSid": "ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -3715,16 +6103,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3733,21 +6123,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" } }, "title": "ListItemAssignmentResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3759,10 +6222,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListItemAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "ListItemAssignment" } }, "/v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments/{Sid}": { @@ -3771,13 +6231,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.", @@ -3816,6 +6276,54 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3827,10 +6335,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchItemAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "FetchItemAssignment" }, "delete": { "description": "Remove an Assignment Item Instance.", @@ -3873,10 +6378,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteItemAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteItemAssignment" } }, "/v2/RegulatoryCompliance/Regulations": { @@ -3885,14 +6387,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.", @@ -3907,6 +6409,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/regulation_enum_end_user_type" + }, + "examples": { + "readEmpty": { + "value": "business" + } } }, { @@ -3915,6 +6422,11 @@ "description": "The ISO country code of the phone number's country.", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "US" + } } }, { @@ -3923,6 +6435,11 @@ "description": "The type of phone number that the regulatory requiremnt is restricting.", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "mobile" + } } }, { @@ -3967,16 +6484,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3985,21 +6504,147 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListRegulationResponse" + }, + "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", + "requirement_name": "individual_info", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations/individual", + "fields": [ + "first_name", + "last_name" + ], + "detailed_fields": [ + { + "machine_name": "first_name", + "friendly_name": "First Name", + "description": "First name of the Individual" + }, + { + "machine_name": "last_name", + "friendly_name": "Last Name", + "description": "Last name of the Individual" + } + ] + } + ], + "supporting_document": [ + [ + { + "name": "Address", + "type": "document", + "requirement_name": "proof_of_address", + "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": [ + "address_sids" + ], + "detailed_fields": [ + { + "machine_name": "address_sids", + "friendly_name": "Address sid(s)", + "description": "Address sid of the individual" + } + ] + } + ] + } + ] + ] + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4011,10 +6656,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRegulation", - "x-maturity": [ - "GA" - ] + "operationId": "ListRegulation" } }, "/v2/RegulatoryCompliance/Regulations/{Sid}": { @@ -4023,14 +6665,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.", @@ -4057,6 +6699,107 @@ "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", + "requirement_name": "individual_info", + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations/individual", + "fields": [ + "first_name", + "last_name" + ], + "detailed_fields": [ + { + "machine_name": "first_name", + "friendly_name": "First Name", + "description": "First name of the Individual" + }, + { + "machine_name": "last_name", + "friendly_name": "Last Name", + "description": "Last name of the Individual" + } + ] + } + ], + "supporting_document": [ + [ + { + "name": "Address", + "type": "document", + "requirement_name": "proof_of_address", + "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": [ + "address_sids" + ], + "detailed_fields": [ + { + "machine_name": "address_sids", + "friendly_name": "Address sid(s)", + "description": "Address sid of the individual" + } + ] + } + ] + } + ] + ] + }, + "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations/RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4068,10 +6811,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRegulation", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRegulation" } }, "/v2/RegulatoryCompliance": { @@ -4080,7 +6820,7 @@ "url": "https://numbers.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], "pathType": "list" @@ -4092,12 +6832,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)", @@ -4124,6 +6864,58 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4136,9 +6928,6 @@ } ], "operationId": "CreateReplaceItems", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4157,6 +6946,13 @@ "required": [ "FromBundleSid" ] + }, + "examples": { + "create": { + "value": { + "FromBundleSid": "BUbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" + } + } } } } @@ -4169,14 +6965,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.", @@ -4189,6 +6985,62 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4201,9 +7053,6 @@ } ], "operationId": "CreateSupportingDocument", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4227,6 +7076,15 @@ "FriendlyName", "Type" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "Type": "type", + "Attributes": "{}" + } + } } } } @@ -4280,16 +7138,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4298,21 +7158,133 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListSupportingDocumentResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4324,10 +7296,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSupportingDocument", - "x-maturity": [ - "GA" - ] + "operationId": "ListSupportingDocument" } }, "/v2/RegulatoryCompliance/SupportingDocuments/{Sid}": { @@ -4336,14 +7305,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.", @@ -4370,6 +7339,62 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4381,10 +7406,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSupportingDocument", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSupportingDocument" }, "post": { "description": "Update an existing Supporting Document.", @@ -4411,6 +7433,62 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4423,9 +7501,6 @@ } ], "operationId": "UpdateSupportingDocument", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4441,12 +7516,17 @@ "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": "{}" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -4478,10 +7558,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSupportingDocument", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSupportingDocument" } }, "/v2/RegulatoryCompliance/SupportingDocumentTypes": { @@ -4490,14 +7567,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.", @@ -4547,16 +7624,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4565,21 +7644,99 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListSupportingDocumentTypeResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4591,10 +7748,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSupportingDocumentType", - "x-maturity": [ - "GA" - ] + "operationId": "ListSupportingDocumentType" } }, "/v2/RegulatoryCompliance/SupportingDocumentTypes/{Sid}": { @@ -4603,14 +7757,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.", @@ -4634,6 +7788,59 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4645,10 +7852,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSupportingDocumentType", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSupportingDocumentType" } } }, @@ -4701,14 +7905,9 @@ "name": "NumbersV2SupportingDocumentType" } ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - }, + "security": [ { - "name": "Beta", - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_oauth_v1.json b/src/services/twilio-api/twilio_oauth_v1.json index 136c08fe..ac5d1a18 100644 --- a/src/services/twilio-api/twilio_oauth_v1.json +++ b/src/services/twilio-api/twilio_oauth_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "oauth.v1.authorize": { "type": "object", @@ -42,12 +48,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -63,7 +63,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -73,7 +73,7 @@ "url": "https://oauth.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "redirect_to" @@ -92,6 +92,11 @@ "description": "Response Type", "schema": { "type": "string" + }, + "examples": { + "fetch": { + "value": "code" + } } }, { @@ -100,6 +105,11 @@ "description": "The Client Identifier", "schema": { "type": "string" + }, + "examples": { + "fetch": { + "value": "OQ7cda1a615f05a95634e643aaaf7081d7" + } } }, { @@ -108,6 +118,11 @@ "description": "The url to which response will be redirected to", "schema": { "type": "string" + }, + "examples": { + "fetch": { + "value": "www.twilio.com" + } } }, { @@ -116,6 +131,11 @@ "description": "The scope of the access request", "schema": { "type": "string" + }, + "examples": { + "fetch": { + "value": "offline_access" + } } }, { @@ -124,6 +144,11 @@ "description": "An opaque value which can be used to maintain state between the request and callback", "schema": { "type": "string" + }, + "examples": { + "fetch": { + "value": "xvz" + } } } ], @@ -133,6 +158,49 @@ "application/json": { "schema": { "$ref": "#/components/schemas/oauth.v1.authorize" + }, + "examples": { + "fetch": { + "value": { + "redirect_to": "https://www.twilio.com/authorize?response_type=code&client_id=OQ7cda1a615f05a95634e643aaaf7081d7&redirect_uri=www.twilio.com&scope=offline_access&state=xvz" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -140,10 +208,7 @@ } }, "security": [], - "operationId": "FetchAuthorize", - "x-maturity": [ - "GA" - ] + "operationId": "FetchAuthorize" } }, "/v1/token": { @@ -152,7 +217,7 @@ "url": "https://oauth.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], "pathType": "list" @@ -168,6 +233,53 @@ "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", + "expires_in": 1438315200000, + "token_type": "bearer" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -176,9 +288,6 @@ }, "security": [], "operationId": "CreateToken", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -223,6 +332,20 @@ "GrantType", "ClientId" ] + }, + "examples": { + "create": { + "value": { + "ClientId": "OQ7cda1a615f05a95634e643aaaf7081d7", + "ClientSecret": "sUWblrQ4wx_aYkdAWjHXNvHinynkYOgBoiRyEQUeEntpgDEG47qnBFD98yoEzsTh", + "GrantType": "client_credentials", + "RedirectUri": "", + "Audience": "", + "Code": "", + "RefreshToken": "refresh_token", + "Scope": "scope" + } + } } } } @@ -243,10 +366,9 @@ "name": "OauthV1Token" } ], - "x-maturity": [ + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_preview.json b/src/services/twilio-api/twilio_preview.json index 691d456f..415fdb0d 100644 --- a/src/services/twilio-api/twilio_preview.json +++ b/src/services/twilio-api/twilio_preview.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "preview.deployed_devices.fleet.certificate": { "type": "object", @@ -1867,12 +1873,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -1888,7 +1888,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -1898,11 +1898,11 @@ "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 Certificate credential in the Fleet.", @@ -1938,6 +1938,57 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" + }, + "examples": { + "fetch": { + "value": { + "sid": "CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "thumbprint": "1234567890", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1949,10 +2000,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDeployedDevicesCertificate", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchDeployedDevicesCertificate" }, "delete": { "description": "Unregister a specific Certificate credential from the Fleet, effectively disallowing any inbound client connections that are presenting it.", @@ -1992,10 +2040,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteDeployedDevicesCertificate", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteDeployedDevicesCertificate" }, "post": { "description": "Update the given properties of a specific Certificate credential in the Fleet, giving it a friendly name or assigning to a Device.", @@ -2031,6 +2076,57 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2043,9 +2139,6 @@ } ], "operationId": "UpdateDeployedDevicesCertificate", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2065,12 +2158,17 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -2080,11 +2178,11 @@ "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": "Enroll a new Certificate credential to the Fleet, optionally giving it a friendly name and assigning to a Device.", @@ -2108,6 +2206,57 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2120,9 +2269,6 @@ } ], "operationId": "CreateDeployedDevicesCertificate", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2149,6 +2295,15 @@ "required": [ "CertificateData" ] + }, + "examples": { + "create": { + "value": { + "CertificateData": "12345678abcdef", + "DeviceSid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name" + } + } } } } @@ -2222,16 +2377,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2240,21 +2397,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" } }, "title": "ListDeployedDevicesCertificateResponse" + }, + "examples": { + "readEmpty": { + "value": { + "certificates": [], + "meta": { + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0", + "key": "certificates", + "next_page_url": null, + "page": 0, + "page_size": 50, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2266,10 +2499,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListDeployedDevicesCertificate", - "x-maturity": [ - "Preview" - ] + "operationId": "ListDeployedDevicesCertificate" } }, "/DeployedDevices/Fleets/{FleetSid}/Deployments/{Sid}": { @@ -2278,11 +2508,11 @@ "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 Deployment in the Fleet.", @@ -2318,6 +2548,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2329,10 +2609,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDeployedDevicesDeployment", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchDeployedDevicesDeployment" }, "delete": { "description": "Delete a specific Deployment from the Fleet, leaving associated devices effectively undeployed.", @@ -2372,10 +2649,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteDeployedDevicesDeployment", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteDeployedDevicesDeployment" }, "post": { "description": "Update the given properties of a specific Deployment credential in the Fleet, giving it a friendly name or linking to a specific Twilio Sync service instance.", @@ -2411,6 +2685,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2423,9 +2747,6 @@ } ], "operationId": "UpdateDeployedDevicesDeployment", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2445,12 +2766,17 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -2460,11 +2786,11 @@ "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 Deployment in the Fleet, optionally giving it a friendly name and linking to a specific Twilio Sync service instance.", @@ -2488,6 +2814,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2500,9 +2876,6 @@ } ], "operationId": "CreateDeployedDevicesDeployment", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2522,12 +2895,17 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -2587,16 +2965,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2605,21 +2985,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" } }, "title": "ListDeployedDevicesDeploymentResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2631,10 +3086,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListDeployedDevicesDeployment", - "x-maturity": [ - "Preview" - ] + "operationId": "ListDeployedDevicesDeployment" } }, "/DeployedDevices/Fleets/{FleetSid}/Devices/{Sid}": { @@ -2643,11 +3095,11 @@ "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 Device in the Fleet.", @@ -2680,8 +3132,62 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } }, "description": "OK" } @@ -2691,10 +3197,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDeployedDevicesDevice", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchDeployedDevicesDevice" }, "delete": { "description": "Delete a specific Device from the Fleet, also removing it from associated Deployments.", @@ -2731,10 +3234,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteDeployedDevicesDevice", - "x-maturity": [ - "Preview" - ] + "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.", @@ -2767,6 +3267,60 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2779,9 +3333,6 @@ } ], "operationId": "UpdateDeployedDevicesDevice", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2809,12 +3360,17 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "Identity": "identity" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -2824,11 +3380,11 @@ "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 Device in the Fleet, optionally giving it a unique name, friendly name, and assigning to a Deployment and/or human identity.", @@ -2852,6 +3408,60 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2864,9 +3474,6 @@ } ], "operationId": "CreateDeployedDevicesDevice", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2898,12 +3505,18 @@ "description": "" } } + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "UniqueName": "unique_name", + "Identity": "identity" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -2974,16 +3587,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2992,21 +3607,100 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListDeployedDevicesDeviceResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3018,10 +3712,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListDeployedDevicesDevice", - "x-maturity": [ - "Preview" - ] + "operationId": "ListDeployedDevicesDevice" } }, "/DeployedDevices/Fleets/{Sid}": { @@ -3030,10 +3721,9 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", "dependentProperties": { "devices": { "mapping": { @@ -3059,7 +3749,8 @@ }, "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Keys" } - } + }, + "pathType": "instance" }, "get": { "description": "Fetch information about a specific Fleet in your account.", @@ -3083,6 +3774,62 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.deployed_devices.fleet" + }, + "examples": { + "fetch": { + "value": { + "sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "devices": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices", + "deployments": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments", + "certificates": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates", + "keys": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3094,10 +3841,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDeployedDevicesFleet", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchDeployedDevicesFleet" }, "delete": { "description": "Delete a specific Fleet from your account, also destroys all nested resources: Devices, Deployments, Certificates, Keys.", @@ -3125,10 +3869,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteDeployedDevicesFleet", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteDeployedDevicesFleet" }, "post": { "description": "Update the friendly name property of a specific Fleet in your account.", @@ -3152,6 +3893,62 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3164,9 +3961,6 @@ } ], "operationId": "UpdateDeployedDevicesFleet", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3186,12 +3980,17 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -3201,10 +4000,9 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "dependentProperties": { "devices": { "mapping": { @@ -3230,7 +4028,8 @@ }, "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Keys" } - } + }, + "pathType": "list" }, "post": { "description": "Create a new Fleet for scoping of deployed devices within your account.", @@ -3243,6 +4042,62 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.deployed_devices.fleet" + }, + "examples": { + "create": { + "value": { + "sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "devices": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices", + "deployments": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments", + "certificates": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates", + "keys": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3255,9 +4110,6 @@ } ], "operationId": "CreateDeployedDevicesFleet", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3270,12 +4122,16 @@ "description": "Provides a human readable descriptive text for this Fleet, up to 256 characters long." } } + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -3326,16 +4182,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3344,21 +4202,102 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListDeployedDevicesFleetResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3370,10 +4309,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListDeployedDevicesFleet", - "x-maturity": [ - "Preview" - ] + "operationId": "ListDeployedDevicesFleet" } }, "/DeployedDevices/Fleets/{FleetSid}/Keys/{Sid}": { @@ -3382,11 +4318,11 @@ "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.", @@ -3422,7 +4358,58 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -3433,10 +4420,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDeployedDevicesKey", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchDeployedDevicesKey" }, "delete": { "description": "Delete a specific Key credential from the Fleet, effectively disallowing any inbound client connections that are presenting it.", @@ -3476,10 +4460,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteDeployedDevicesKey", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteDeployedDevicesKey" }, "post": { "description": "Update the given properties of a specific Key credential in the Fleet, giving it a friendly name or assigning to a Device.", @@ -3515,6 +4496,57 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" + }, + "examples": { + "update": { + "value": { + "sid": "KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "secret": null, + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3527,9 +4559,6 @@ } ], "operationId": "UpdateDeployedDevicesKey", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3549,12 +4578,17 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -3564,11 +4598,11 @@ "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.", @@ -3592,6 +4626,57 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3604,9 +4689,6 @@ } ], "operationId": "CreateDeployedDevicesKey", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3626,12 +4708,17 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -3702,16 +4789,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3720,21 +4809,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" } }, "title": "ListDeployedDevicesKeyResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3746,10 +4911,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListDeployedDevicesKey", - "x-maturity": [ - "Preview" - ] + "operationId": "ListDeployedDevicesKey" } }, "/HostedNumbers/AuthorizationDocuments/{Sid}": { @@ -3758,10 +4920,9 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", "dependentProperties": { "dependent_hosted_number_orders": { "mapping": { @@ -3769,7 +4930,8 @@ }, "resource_url": "/HostedNumbers/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders" } - } + }, + "pathType": "instance" }, "get": { "description": "Fetch a specific AuthorizationDocument.", @@ -3796,6 +4958,62 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" + }, + "examples": { + "fetch": { + "value": { + "address_sid": "AD11111111111111111111111111111111", + "cc_emails": [ + "aaa@twilio.com", + "bbb@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test@twilio.com", + "links": { + "dependent_hosted_number_orders": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders" + }, + "sid": "PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "signing", + "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3807,10 +5025,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchHostedNumbersAuthorizationDocument", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchHostedNumbersAuthorizationDocument" }, "post": { "description": "Updates a specific AuthorizationDocument.", @@ -3837,6 +5052,62 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" + }, + "examples": { + "update": { + "value": { + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "cc_emails": [ + "test1@twilio.com", + "test2@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test+hosted@twilio.com", + "links": { + "dependent_hosted_number_orders": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders" + }, + "sid": "PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "signing", + "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3849,9 +5120,6 @@ } ], "operationId": "UpdateHostedNumbersAuthorizationDocument", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3898,12 +5166,28 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -3913,10 +5197,9 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "dependentProperties": { "dependent_hosted_number_orders": { "mapping": { @@ -3924,7 +5207,8 @@ }, "resource_url": "/HostedNumbers/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders" } - } + }, + "pathType": "list" }, "get": { "description": "Retrieve a list of AuthorizationDocuments belonging to the account initiating the request.", @@ -3944,6 +5228,11 @@ "handling": "standard", "deleteSla": 30 } + }, + "examples": { + "readEmpty": { + "value": "test+hosted@twilio.com" + } } }, { @@ -3953,6 +5242,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/authorization_document_enum_status" + }, + "examples": { + "readEmpty": { + "value": "signed" + } } }, { @@ -3997,16 +5291,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4015,21 +5311,102 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListHostedNumbersAuthorizationDocumentResponse" + }, + "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" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4041,10 +5418,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListHostedNumbersAuthorizationDocument", - "x-maturity": [ - "Preview" - ] + "operationId": "ListHostedNumbersAuthorizationDocument" }, "post": { "description": "Create an AuthorizationDocument for authorizing the hosting of phone number capabilities on Twilio's platform.", @@ -4057,6 +5431,62 @@ "application/json": { "schema": { "$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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4069,9 +5499,6 @@ } ], "operationId": "CreateHostedNumbersAuthorizationDocument", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4120,6 +5547,24 @@ "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" + } + } } } } @@ -4132,11 +5577,11 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "parent": "/AuthorizationDocuments/{Sid}" + "parent": "/AuthorizationDocuments/{Sid}", + "pathType": "list" }, "get": { "description": "Retrieve a list of dependent HostedNumberOrders belonging to the AuthorizationDocument.", @@ -4163,7 +5608,12 @@ "schema": { "type": "string", "$ref": "#/components/schemas/dependent_hosted_number_order_enum_status" - } + }, + "examples": { + "readEmpty": { + "value": "completed" + } + } }, { "name": "PhoneNumber", @@ -4172,6 +5622,11 @@ "schema": { "type": "string", "format": "phone-number" + }, + "examples": { + "readEmpty": { + "value": "+19193608000" + } } }, { @@ -4183,6 +5638,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^PN[0-9a-fA-F]{32}$" + }, + "examples": { + "readEmpty": { + "value": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -4197,6 +5657,11 @@ "handling": "standard", "deleteSla": 30 } + }, + "examples": { + "readEmpty": { + "value": "example" + } } }, { @@ -4211,6 +5676,11 @@ "handling": "standard", "deleteSla": 30 } + }, + "examples": { + "readEmpty": { + "value": "something123" + } } }, { @@ -4255,16 +5725,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4273,21 +5745,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" } }, "title": "ListHostedNumbersDependentHostedNumberOrderResponse" + }, + "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" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4299,10 +5869,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListHostedNumbersDependentHostedNumberOrder", - "x-maturity": [ - "Preview" - ] + "operationId": "ListHostedNumbersDependentHostedNumberOrder" } }, "/HostedNumbers/HostedNumberOrders/{Sid}": { @@ -4311,7 +5878,7 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], "pathType": "instance" @@ -4341,6 +5908,80 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_sid": "AD11111111111111111111111111111111", + "call_delay": 15, + "capabilities": { + "sms": true, + "voice": false + }, + "cc_emails": [ + "aaa@twilio.com", + "bbb@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test@twilio.com", + "extension": "5105", + "failure_reason": "", + "friendly_name": "friendly_name", + "incoming_phone_number_sid": "PN11111111111111111111111111111111", + "phone_number": "+14153608311", + "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "signing_document_sid": "PX11111111111111111111111111111111", + "status": "received", + "unique_name": "foobar", + "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verification_attempts": 0, + "verification_call_sids": [ + "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + ], + "verification_code": "8794", + "verification_document_sid": null, + "verification_type": "phone-call" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4352,10 +5993,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchHostedNumbersHostedNumberOrder", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchHostedNumbersHostedNumberOrder" }, "delete": { "description": "Cancel the HostedNumberOrder (only available when the status is in `received`).", @@ -4386,10 +6024,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteHostedNumbersHostedNumberOrder", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteHostedNumbersHostedNumberOrder" }, "post": { "description": "Updates a specific HostedNumberOrder.", @@ -4416,6 +6051,80 @@ "application/json": { "schema": { "$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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4428,9 +6137,6 @@ } ], "operationId": "UpdateHostedNumbersHostedNumberOrder", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4487,12 +6193,25 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -4502,7 +6221,7 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], "pathType": "list" @@ -4520,6 +6239,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/hosted_number_order_enum_status" + }, + "examples": { + "readEmpty": { + "value": "completed" + } } }, { @@ -4529,6 +6253,11 @@ "schema": { "type": "string", "format": "phone-number" + }, + "examples": { + "readEmpty": { + "value": "+19193608000" + } } }, { @@ -4540,6 +6269,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^PN[0-9a-fA-F]{32}$" + }, + "examples": { + "readEmpty": { + "value": "PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz" + } } }, { @@ -4554,6 +6288,11 @@ "handling": "standard", "deleteSla": 30 } + }, + "examples": { + "readEmpty": { + "value": "example" + } } }, { @@ -4568,6 +6307,11 @@ "handling": "standard", "deleteSla": 30 } + }, + "examples": { + "readEmpty": { + "value": "something123" + } } }, { @@ -4612,16 +6356,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4630,21 +6376,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" } }, "title": "ListHostedNumbersHostedNumberOrderResponse" + }, + "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" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4656,10 +6501,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListHostedNumbersHostedNumberOrder", - "x-maturity": [ - "Preview" - ] + "operationId": "ListHostedNumbersHostedNumberOrder" }, "post": { "description": "Host a phone number's capability on Twilio's platform.", @@ -4672,6 +6514,134 @@ "application/json": { "schema": { "$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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4684,9 +6654,6 @@ } ], "operationId": "CreateHostedNumbersHostedNumberOrder", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4802,6 +6769,30 @@ "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" + } + } } } } @@ -4814,10 +6805,9 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", "dependentProperties": { "extensions": { "mapping": { @@ -4825,7 +6815,8 @@ }, "resource_url": "/marketplace/AvailableAddOns/{available_add_on_sid}/Extensions" } - } + }, + "pathType": "instance" }, "get": { "description": "Fetch an instance of an Add-on currently available to be installed.", @@ -4852,6 +6843,67 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.marketplace.available_add_on" + }, + "examples": { + "fetch": { + "value": { + "sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "VoiceBase High Accuracy Transcription", + "description": "Automatic Transcription and Keyword Extract...", + "pricing_type": "per minute", + "configuration_schema": { + "type": "object", + "properties": { + "bad_words": { + "type": "boolean" + } + }, + "required": [ + "bad_words" + ] + }, + "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "extensions": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4863,10 +6915,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMarketplaceAvailableAddOn", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchMarketplaceAvailableAddOn" } }, "/marketplace/AvailableAddOns": { @@ -4875,10 +6924,9 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "dependentProperties": { "extensions": { "mapping": { @@ -4886,7 +6934,8 @@ }, "resource_url": "/marketplace/AvailableAddOns/{available_add_on_sid}/Extensions" } - } + }, + "pathType": "list" }, "get": { "description": "Retrieve a list of Add-ons currently available to be installed.", @@ -4936,16 +6985,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4954,21 +7005,107 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListMarketplaceAvailableAddOnResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4980,10 +7117,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMarketplaceAvailableAddOn", - "x-maturity": [ - "Preview" - ] + "operationId": "ListMarketplaceAvailableAddOn" } }, "/marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions/{Sid}": { @@ -4992,12 +7126,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.", @@ -5036,6 +7170,54 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5047,10 +7229,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMarketplaceAvailableAddOnExtension", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchMarketplaceAvailableAddOnExtension" } }, "/marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions": { @@ -5059,12 +7238,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.", @@ -5126,16 +7305,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5144,21 +7325,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" } }, "title": "ListMarketplaceAvailableAddOnExtensionResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5170,10 +7424,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMarketplaceAvailableAddOnExtension", - "x-maturity": [ - "Preview" - ] + "operationId": "ListMarketplaceAvailableAddOnExtension" } }, "/marketplace/InstalledAddOns": { @@ -5182,10 +7433,9 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "dependentProperties": { "extensions": { "mapping": { @@ -5199,7 +7449,8 @@ }, "resource_url": "/marketplace/InstalledAddOns/{installed_add_on_sid}/Usage" } - } + }, + "pathType": "list" }, "post": { "description": "Install an Add-on for the Account specified.", @@ -5212,6 +7463,63 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5224,9 +7532,6 @@ } ], "operationId": "CreateMarketplaceInstalledAddOn", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5257,6 +7562,16 @@ "AvailableAddOnSid", "AcceptTermsOfService" ] + }, + "examples": { + "create": { + "value": { + "AvailableAddOnSid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "AcceptTermsOfService": true, + "Configuration": "{\"bad_words\": true}", + "UniqueName": "voicebase_high_accuracy_transcription_1" + } + } } } } @@ -5310,16 +7625,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5328,21 +7645,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" } }, "title": "ListMarketplaceInstalledAddOnResponse" + }, + "examples": { + "readFull": { + "value": { + "installed_add_ons": [ + { + "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "VoiceBase High Accuracy Transcription", + "description": "Automatic Transcription and Keyword Extract...", + "configuration": { + "bad_words": true + }, + "unique_name": "voicebase_high_accuracy_transcription", + "date_created": "2016-04-07T23:52:28Z", + "date_updated": "2016-04-07T23:52:28Z", + "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "extensions": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions", + "available_add_on": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + ], + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5354,10 +7753,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMarketplaceInstalledAddOn", - "x-maturity": [ - "Preview" - ] + "operationId": "ListMarketplaceInstalledAddOn" } }, "/marketplace/InstalledAddOns/{Sid}": { @@ -5366,10 +7762,9 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", "dependentProperties": { "extensions": { "mapping": { @@ -5383,7 +7778,8 @@ }, "resource_url": "/marketplace/InstalledAddOns/{installed_add_on_sid}/Usage" } - } + }, + "pathType": "instance" }, "delete": { "description": "Remove an Add-on installation from your account", @@ -5414,10 +7810,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMarketplaceInstalledAddOn", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteMarketplaceInstalledAddOn" }, "get": { "description": "Fetch an instance of an Add-on currently installed on this Account.", @@ -5444,6 +7837,63 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5455,10 +7905,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMarketplaceInstalledAddOn", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchMarketplaceInstalledAddOn" }, "post": { "description": "Update an Add-on installation for the Account specified.", @@ -5485,6 +7932,63 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.marketplace.installed_add_on" + }, + "examples": { + "update": { + "value": { + "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "VoiceBase High Accuracy Transcription", + "description": "Automatic Transcription and Keyword Extract...", + "configuration": { + "bad_words": true + }, + "unique_name": "voicebase_high_accuracy_transcription_2", + "date_created": "2016-04-07T23:52:28Z", + "date_updated": "2016-04-07T23:52:28Z", + "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "extensions": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions", + "available_add_on": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5497,9 +8001,6 @@ } ], "operationId": "UpdateMarketplaceInstalledAddOn", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5515,12 +8016,17 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -5530,12 +8036,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.", @@ -5574,6 +8080,55 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" + }, + "examples": { + "fetch": { + "value": { + "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "installed_add_on_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Incoming Voice Call", + "product_name": "Programmable Voice", + "unique_name": "voice-incoming", + "enabled": true, + "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5585,10 +8140,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMarketplaceInstalledAddOnExtension", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchMarketplaceInstalledAddOnExtension" }, "post": { "description": "Update an Extension for an Add-on installation.", @@ -5627,6 +8179,55 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5639,9 +8240,6 @@ } ], "operationId": "UpdateMarketplaceInstalledAddOnExtension", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5657,6 +8255,13 @@ "required": [ "Enabled" ] + }, + "examples": { + "update": { + "value": { + "Enabled": false + } + } } } } @@ -5669,12 +8274,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.", @@ -5736,16 +8341,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5754,21 +8361,95 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListMarketplaceInstalledAddOnExtensionResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5780,10 +8461,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMarketplaceInstalledAddOnExtension", - "x-maturity": [ - "Preview" - ] + "operationId": "ListMarketplaceInstalledAddOnExtension" } }, "/Sync/Services/{ServiceSid}/Documents/{Sid}": { @@ -5792,10 +8470,9 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", "dependentProperties": { "permissions": { "mapping": { @@ -5805,7 +8482,8 @@ "resource_url": "/Sync/Services/{service_sid}/Documents/{document_sid}/Permissions" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -5841,6 +8519,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" + } + } + } } } }, @@ -5849,6 +8546,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -5859,10 +8590,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncDocument", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchSyncDocument" }, "delete": { "description": "", @@ -5902,10 +8630,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncDocument", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteSyncDocument" }, "post": { "description": "", @@ -5949,6 +8674,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" + } + } + } } } }, @@ -5957,6 +8701,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -5968,9 +8746,6 @@ } ], "operationId": "UpdateSyncDocument", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5985,6 +8760,14 @@ "required": [ "Data" ] + }, + "examples": { + "update": { + "value": { + "Data": "{}", + "UniqueName": "unique_name" + } + } } } } @@ -5997,10 +8780,9 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "dependentProperties": { "permissions": { "mapping": { @@ -6010,7 +8792,8 @@ "resource_url": "/Sync/Services/{service_sid}/Documents/{document_sid}/Permissions" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -6037,6 +8820,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" + } + } + } } } }, @@ -6045,6 +8847,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "Created" @@ -6056,9 +8892,6 @@ } ], "operationId": "CreateSyncDocument", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6074,12 +8907,17 @@ "description": "" } } + }, + "examples": { + "create": { + "value": { + "Data": "{}", + "UniqueName": "unique_name" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -6142,16 +8980,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -6160,21 +9000,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" } }, "title": "ListSyncDocumentResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6186,10 +9106,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncDocument", - "x-maturity": [ - "Preview" - ] + "operationId": "ListSyncDocument" } }, "/Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}": { @@ -6198,12 +9115,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.", @@ -6248,6 +9165,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6259,10 +9226,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncDocumentPermission", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchSyncDocumentPermission" }, "delete": { "description": "Delete a specific Sync Document Permission.", @@ -6311,10 +9275,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncDocumentPermission", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteSyncDocumentPermission" }, "post": { "description": "Update an identity's access to a specific Sync Document.", @@ -6359,6 +9320,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6371,9 +9382,6 @@ } ], "operationId": "UpdateSyncDocumentPermission", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6399,6 +9407,15 @@ "Write", "Manage" ] + }, + "examples": { + "update": { + "value": { + "Read": "true", + "Write": "true", + "Manage": "true" + } + } } } } @@ -6411,12 +9428,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.", @@ -6487,16 +9504,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -6505,21 +9524,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" } }, "title": "ListSyncDocumentPermissionResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6531,10 +9625,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncDocumentPermission", - "x-maturity": [ - "Preview" - ] + "operationId": "ListSyncDocumentPermission" } }, "/Sync/Services/{Sid}": { @@ -6543,10 +9634,9 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", "dependentProperties": { "documents": { "mapping": { @@ -6566,7 +9656,8 @@ }, "resource_url": "/Sync/Services/{service_sid}/Maps" } - } + }, + "pathType": "instance" }, "get": { "description": "", @@ -6593,21 +9684,74 @@ "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" - } + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } }, "security": [ { "accountSid_authToken": [] } ], - "operationId": "FetchSyncService", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchSyncService" }, "delete": { "description": "", @@ -6638,10 +9782,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncService", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteSyncService" }, "post": { "description": "", @@ -6668,6 +9809,62 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.service" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "links": { + "documents": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", + "lists": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", + "maps": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps" + }, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_url": "http://www.example.com", + "reachability_webhooks_enabled": false, + "acl_enabled": true + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6680,9 +9877,6 @@ } ], "operationId": "UpdateSyncService", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6708,12 +9902,18 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "WebhookUrl": "http://www.example.com", + "AclEnabled": true + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -6723,10 +9923,9 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "dependentProperties": { "documents": { "mapping": { @@ -6746,7 +9945,8 @@ }, "resource_url": "/Sync/Services/{service_sid}/Maps" } - } + }, + "pathType": "list" }, "post": { "description": "", @@ -6759,6 +9959,62 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.sync.service" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "links": { + "documents": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", + "lists": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", + "maps": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps" + }, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_url": "http://www.example.com", + "reachability_webhooks_enabled": false, + "acl_enabled": true + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6771,9 +10027,6 @@ } ], "operationId": "CreateSyncService", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6799,12 +10052,18 @@ "description": "" } } + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "WebhookUrl": "http://www.example.com", + "AclEnabled": true + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -6855,16 +10114,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -6873,21 +10134,102 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListSyncServiceResponse" + }, + "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 + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6899,10 +10241,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncService", - "x-maturity": [ - "Preview" - ] + "operationId": "ListSyncService" } }, "/Sync/Services/{ServiceSid}/Lists/{Sid}": { @@ -6911,10 +10250,9 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", "dependentProperties": { "items": { "mapping": { @@ -6932,7 +10270,8 @@ } }, "parent": "/Services/{Sid}", - "mountName": "sync_lists" + "mountName": "sync_lists", + "pathType": "instance" }, "get": { "description": "", @@ -6968,6 +10307,61 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6979,10 +10373,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncSyncList", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchSyncSyncList" }, "delete": { "description": "", @@ -7022,10 +10413,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncSyncList", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteSyncSyncList" } }, "/Sync/Services/{ServiceSid}/Lists": { @@ -7034,10 +10422,9 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "dependentProperties": { "items": { "mapping": { @@ -7055,7 +10442,8 @@ } }, "parent": "/Services/{Sid}", - "mountName": "sync_lists" + "mountName": "sync_lists", + "pathType": "list" }, "post": { "description": "", @@ -7082,6 +10470,61 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -7094,9 +10537,6 @@ } ], "operationId": "CreateSyncSyncList", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -7109,12 +10549,16 @@ "description": "" } } + }, + "examples": { + "create": { + "value": { + "UniqueName": "unique_name" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -7177,16 +10621,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -7195,21 +10641,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" } }, "title": "ListSyncSyncListResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -7221,10 +10747,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncSyncList", - "x-maturity": [ - "Preview" - ] + "operationId": "ListSyncSyncList" } }, "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}": { @@ -7233,12 +10756,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": "", @@ -7283,6 +10806,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" + } + } } } }, @@ -7291,6 +10830,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -7301,10 +10874,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncSyncListItem", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchSyncSyncListItem" }, "delete": { "description": "", @@ -7361,10 +10931,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncSyncListItem", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteSyncSyncListItem" }, "post": { "description": "", @@ -7417,6 +10984,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" + } + } } } }, @@ -7425,21 +11008,52 @@ "schema": { "type": "string" } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateSyncSyncListItem", - "x-maturity": [ - "Preview" - ], - "requestBody": { + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateSyncSyncListItem", + "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { @@ -7453,6 +11067,13 @@ "required": [ "Data" ] + }, + "examples": { + "update": { + "value": { + "Data": "{}" + } + } } } } @@ -7465,12 +11086,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": "", @@ -7506,6 +11127,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" + } + } } } }, @@ -7514,6 +11151,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "Created" @@ -7525,9 +11196,6 @@ } ], "operationId": "CreateSyncSyncListItem", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -7542,6 +11210,13 @@ "required": [ "Data" ] + }, + "examples": { + "create": { + "value": { + "Data": "{}" + } + } } } } @@ -7581,6 +11256,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/sync_list_item_enum_query_result_order" + }, + "examples": { + "readEmpty": { + "value": "asc" + }, + "readFull": { + "value": "asc" + } } }, { @@ -7589,6 +11272,14 @@ "description": "", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "from" + }, + "readFull": { + "value": "from" + } } }, { @@ -7598,6 +11289,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/sync_list_item_enum_query_from_bound_type" + }, + "examples": { + "readEmpty": { + "value": "inclusive" + }, + "readFull": { + "value": "inclusive" + } } }, { @@ -7642,16 +11341,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -7660,21 +11361,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" } }, "title": "ListSyncSyncListItemResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -7686,10 +11464,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncSyncListItem", - "x-maturity": [ - "Preview" - ] + "operationId": "ListSyncSyncListItem" } }, "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}": { @@ -7698,12 +11473,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.", @@ -7748,6 +11523,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -7759,10 +11584,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncSyncListPermission", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchSyncSyncListPermission" }, "delete": { "description": "Delete a specific Sync List Permission.", @@ -7811,10 +11633,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncSyncListPermission", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteSyncSyncListPermission" }, "post": { "description": "Update an identity's access to a specific Sync List.", @@ -7859,6 +11678,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -7871,9 +11740,6 @@ } ], "operationId": "UpdateSyncSyncListPermission", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -7899,6 +11765,15 @@ "Write", "Manage" ] + }, + "examples": { + "update": { + "value": { + "Read": "true", + "Write": "true", + "Manage": "true" + } + } } } } @@ -7911,12 +11786,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.", @@ -7987,16 +11862,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -8005,21 +11882,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" } }, "title": "ListSyncSyncListPermissionResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -8031,10 +11983,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncSyncListPermission", - "x-maturity": [ - "Preview" - ] + "operationId": "ListSyncSyncListPermission" } }, "/Sync/Services/{ServiceSid}/Maps/{Sid}": { @@ -8043,10 +11992,9 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", "dependentProperties": { "items": { "mapping": { @@ -8064,7 +12012,8 @@ } }, "parent": "/Services/{Sid}", - "mountName": "sync_maps" + "mountName": "sync_maps", + "pathType": "instance" }, "get": { "description": "", @@ -8100,6 +12049,61 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -8111,10 +12115,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncSyncMap", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchSyncSyncMap" }, "delete": { "description": "", @@ -8154,10 +12155,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncSyncMap", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteSyncSyncMap" } }, "/Sync/Services/{ServiceSid}/Maps": { @@ -8166,10 +12164,9 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "dependentProperties": { "items": { "mapping": { @@ -8187,7 +12184,8 @@ } }, "parent": "/Services/{Sid}", - "mountName": "sync_maps" + "mountName": "sync_maps", + "pathType": "list" }, "post": { "description": "", @@ -8214,6 +12212,61 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -8226,9 +12279,6 @@ } ], "operationId": "CreateSyncSyncMap", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -8241,12 +12291,16 @@ "description": "" } } + }, + "examples": { + "create": { + "value": { + "UniqueName": "unique_name" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -8309,16 +12363,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -8327,21 +12383,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" } }, "title": "ListSyncSyncMapResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -8353,10 +12489,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncSyncMap", - "x-maturity": [ - "Preview" - ] + "operationId": "ListSyncSyncMap" } }, "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}": { @@ -8365,12 +12498,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": "", @@ -8415,6 +12548,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" + } + } } } }, @@ -8423,6 +12572,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -8433,10 +12616,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncSyncMapItem", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchSyncSyncMapItem" }, "delete": { "description": "", @@ -8493,10 +12673,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncSyncMapItem", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteSyncSyncMapItem" }, "post": { "description": "", @@ -8549,6 +12726,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" + } + } } } }, @@ -8557,6 +12750,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -8568,9 +12795,6 @@ } ], "operationId": "UpdateSyncSyncMapItem", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -8585,6 +12809,13 @@ "required": [ "Data" ] + }, + "examples": { + "update": { + "value": { + "Data": "{}" + } + } } } } @@ -8597,12 +12828,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": "", @@ -8638,6 +12869,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" + } + } } } }, @@ -8646,6 +12893,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "Created" @@ -8657,9 +12938,6 @@ } ], "operationId": "CreateSyncSyncMapItem", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -8679,6 +12957,14 @@ "Key", "Data" ] + }, + "examples": { + "create": { + "value": { + "Data": "{}", + "Key": "key" + } + } } } } @@ -8718,6 +13004,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/sync_map_item_enum_query_result_order" + }, + "examples": { + "readEmpty": { + "value": "asc" + }, + "readFull": { + "value": "asc" + } } }, { @@ -8726,6 +13020,14 @@ "description": "", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "from" + }, + "readFull": { + "value": "from" + } } }, { @@ -8735,6 +13037,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/sync_map_item_enum_query_from_bound_type" + }, + "examples": { + "readEmpty": { + "value": "inclusive" + }, + "readFull": { + "value": "inclusive" + } } }, { @@ -8779,16 +13089,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -8797,21 +13109,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" } }, "title": "ListSyncSyncMapItemResponse" + }, + "examples": { + "readEmpty": { + "value": { + "items": [], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "items": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "key": "key", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -8823,10 +13212,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncSyncMapItem", - "x-maturity": [ - "Preview" - ] + "operationId": "ListSyncSyncMapItem" } }, "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}": { @@ -8835,12 +13221,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.", @@ -8885,6 +13271,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -8896,10 +13332,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncSyncMapPermission", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchSyncSyncMapPermission" }, "delete": { "description": "Delete a specific Sync Map Permission.", @@ -8948,10 +13381,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncSyncMapPermission", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteSyncSyncMapPermission" }, "post": { "description": "Update an identity's access to a specific Sync Map.", @@ -8996,6 +13426,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -9008,9 +13488,6 @@ } ], "operationId": "UpdateSyncSyncMapPermission", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -9036,6 +13513,15 @@ "Write", "Manage" ] + }, + "examples": { + "update": { + "value": { + "Read": "true", + "Write": "true", + "Manage": "true" + } + } } } } @@ -9048,12 +13534,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.", @@ -9124,16 +13610,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -9142,46 +13630,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" } }, "title": "ListSyncSyncMapPermissionResponse" + }, + "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": "ListSyncSyncMapPermission", - "x-maturity": [ - "Preview" - ] - } - }, - "/wireless/Commands/{Sid}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListSyncSyncMapPermission" + } + }, + "/wireless/Commands/{Sid}": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { "defaultOutputProperties": [], "pathType": "instance" }, @@ -9210,6 +13770,59 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.wireless.command" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "command": "command", + "command_mode": "command_mode", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "device_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "direction": "direction", + "sid": "DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "status", + "url": "https://preview.twilio.com/wireless/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -9221,10 +13834,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWirelessCommand", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchWirelessCommand" } }, "/wireless/Commands": { @@ -9233,7 +13843,7 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], "pathType": "list" @@ -9250,6 +13860,14 @@ "description": "", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "device" + }, + "readFull": { + "value": "device" + } } }, { @@ -9258,6 +13876,14 @@ "description": "", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "sim" + }, + "readFull": { + "value": "sim" + } } }, { @@ -9266,6 +13892,14 @@ "description": "", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "status" + }, + "readFull": { + "value": "status" + } } }, { @@ -9274,6 +13908,14 @@ "description": "", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "direction" + }, + "readFull": { + "value": "direction" + } } }, { @@ -9318,16 +13960,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -9336,21 +13980,99 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListWirelessCommandResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -9362,10 +14084,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListWirelessCommand", - "x-maturity": [ - "Preview" - ] + "operationId": "ListWirelessCommand" }, "post": { "description": "", @@ -9378,6 +14097,59 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.wireless.command" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "command": "command", + "command_mode": "command_mode", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "device_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "direction": "direction", + "sid": "DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "status", + "url": "https://preview.twilio.com/wireless/Commands/DCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -9390,9 +14162,6 @@ } ], "operationId": "CreateWirelessCommand", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -9433,6 +14202,19 @@ "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" + } + } } } } @@ -9445,7 +14227,7 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], "pathType": "list" @@ -9498,16 +14280,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -9516,21 +14300,106 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListWirelessRatePlanResponse" + }, + "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" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -9542,10 +14411,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListWirelessRatePlan", - "x-maturity": [ - "Preview" - ] + "operationId": "ListWirelessRatePlan" }, "post": { "description": "", @@ -9558,6 +14424,66 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -9570,9 +14496,6 @@ } ], "operationId": "CreateWirelessRatePlan", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -9624,12 +14547,29 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -9639,7 +14579,7 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], "pathType": "instance" @@ -9666,6 +14606,66 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -9677,10 +14677,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWirelessRatePlan", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchWirelessRatePlan" }, "post": { "description": "", @@ -9704,6 +14701,66 @@ "application/json": { "schema": { "$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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -9716,9 +14773,6 @@ } ], "operationId": "UpdateWirelessRatePlan", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -9735,12 +14789,17 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "UniqueName": "unique_name", + "FriendlyName": "friendly_name" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -9769,10 +14828,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteWirelessRatePlan", - "x-maturity": [ - "Preview" - ] + "operationId": "DeleteWirelessRatePlan" } }, "/wireless/Sims/{Sid}": { @@ -9781,10 +14837,9 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", "dependentProperties": { "usage": { "mapping": { @@ -9792,7 +14847,8 @@ }, "resource_url": "/wireless/Sims/{sim_sid}/Usage" } - } + }, + "pathType": "instance" }, "get": { "description": "", @@ -9816,6 +14872,73 @@ "application/json": { "schema": { "$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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -9827,10 +14950,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWirelessSim", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchWirelessSim" }, "post": { "description": "", @@ -9854,6 +14974,73 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.wireless.sim" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "commands_callback_method": "http_method", + "commands_callback_url": "http://www.example.com", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "links": { + "usage": "https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage", + "rate_plan": "https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "rate_plan_sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "iccid", + "e_id": "e_id", + "status": "status", + "sms_fallback_method": "http_method", + "sms_fallback_url": "http://www.example.com", + "sms_method": "http_method", + "sms_url": "http://www.example.com", + "voice_fallback_method": "http_method", + "voice_fallback_url": "http://www.example.com", + "voice_method": "http_method", + "voice_url": "http://www.example.com", + "url": "https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -9866,9 +15053,6 @@ } ], "operationId": "UpdateWirelessSim", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -9972,12 +15156,31 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -9987,10 +15190,9 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", "dependentProperties": { "usage": { "mapping": { @@ -9998,7 +15200,8 @@ }, "resource_url": "/wireless/Sims/{sim_sid}/Usage" } - } + }, + "pathType": "list" }, "get": { "description": "", @@ -10012,6 +15215,14 @@ "description": "", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "status" + }, + "readFull": { + "value": "status" + } } }, { @@ -10020,6 +15231,14 @@ "description": "", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "iccid" + }, + "readFull": { + "value": "iccid" + } } }, { @@ -10028,6 +15247,14 @@ "description": "", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "rate_plan" + }, + "readFull": { + "value": "rate_plan" + } } }, { @@ -10088,16 +15315,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -10106,21 +15335,113 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListWirelessSimResponse" + }, + "examples": { + "readEmpty": { + "value": { + "sims": [], + "meta": { + "first_page_url": "https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0", + "key": "sims", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "sims": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "commands_callback_method": "http_method", + "commands_callback_url": "http://www.example.com", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "links": { + "usage": "https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage", + "rate_plan": "https://preview.twilio.com/wireless/RatePlans/WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "rate_plan_sid": "WPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "iccid": "iccid", + "e_id": "e_id", + "status": "status", + "sms_fallback_method": "http_method", + "sms_fallback_url": "http://www.example.com", + "sms_method": "http_method", + "sms_url": "http://www.example.com", + "voice_fallback_method": "http_method", + "voice_fallback_url": "http://www.example.com", + "voice_method": "http_method", + "voice_url": "http://www.example.com", + "url": "https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0", + "key": "sims", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&PageSize=50&Page=0" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -10132,10 +15453,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListWirelessSim", - "x-maturity": [ - "Preview" - ] + "operationId": "ListWirelessSim" } }, "/wireless/Sims/{SimSid}/Usage": { @@ -10144,11 +15462,11 @@ "url": "https://preview.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Sims/{Sid}" + "parent": "/Sims/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -10171,6 +15489,11 @@ "description": "", "schema": { "type": "string" + }, + "examples": { + "fetch": { + "value": "end" + } } }, { @@ -10179,6 +15502,11 @@ "description": "", "schema": { "type": "string" + }, + "examples": { + "fetch": { + "value": "start" + } } } ], @@ -10188,6 +15516,57 @@ "application/json": { "schema": { "$ref": "#/components/schemas/preview.wireless.sim.usage" + }, + "examples": { + "fetch": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "commands_costs": {}, + "commands_usage": {}, + "data_costs": {}, + "data_usage": {}, + "sim_unique_name": "sim_unique_name", + "sim_sid": "DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "period": {}, + "url": "https://preview.twilio.com/wireless/Sims/DEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Usage" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -10199,10 +15578,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWirelessUsage", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchWirelessUsage" } } }, @@ -10226,72 +15602,11 @@ }, { "name": "PreviewDeployedDevicesKey" - }, - { - "name": "PreviewHostedNumbersAuthorizationDocument" - }, - { - "name": "PreviewHostedNumbersDependentHostedNumberOrder" - }, - { - "name": "PreviewHostedNumbersHostedNumberOrder" - }, - { - "name": "PreviewMarketplaceAvailableAddOn" - }, - { - "name": "PreviewMarketplaceAvailableAddOnExtension" - }, - { - "name": "PreviewMarketplaceInstalledAddOn" - }, - { - "name": "PreviewMarketplaceInstalledAddOnExtension" - }, - { - "name": "PreviewSyncDocument" - }, - { - "name": "PreviewSyncDocumentPermission" - }, - { - "name": "PreviewSyncService" - }, - { - "name": "PreviewSyncSyncList" - }, - { - "name": "PreviewSyncSyncListItem" - }, - { - "name": "PreviewSyncSyncListPermission" - }, - { - "name": "PreviewSyncSyncMap" - }, - { - "name": "PreviewSyncSyncMapItem" - }, - { - "name": "PreviewSyncSyncMapPermission" - }, - { - "name": "PreviewWirelessCommand" - }, - { - "name": "PreviewWirelessRatePlan" - }, - { - "name": "PreviewWirelessSim" - }, - { - "name": "PreviewWirelessUsage" } ], - "x-maturity": [ + "security": [ { - "name": "Preview", - "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact https://www.twilio.com/help/contact." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_pricing_v1.json b/src/services/twilio-api/twilio_pricing_v1.json index cb792a61..1a9cb5ce 100644 --- a/src/services/twilio-api/twilio_pricing_v1.json +++ b/src/services/twilio-api/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.56.1" + "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": "", @@ -500,16 +500,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -518,21 +520,91 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListMessagingCountryResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -544,10 +616,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMessagingCountry", - "x-maturity": [ - "GA" - ] + "operationId": "ListMessagingCountry" } }, "/v1/Messaging/Countries/{IsoCountry}": { @@ -564,8 +633,8 @@ "inbound_sms_prices", "price_unit" ], - "pathType": "instance", - "parent": "/Messaging" + "parent": "/Messaging", + "pathType": "instance" }, "get": { "description": "", @@ -590,6 +659,73 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -601,10 +737,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMessagingCountry", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMessagingCountry" } }, "/v1/PhoneNumbers": { @@ -613,7 +746,7 @@ "url": "https://pricing.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "name" @@ -633,8 +766,8 @@ "country", "price_unit" ], - "pathType": "list", - "parent": "/PhoneNumbers" + "parent": "/PhoneNumbers", + "pathType": "list" }, "get": { "description": "", @@ -684,16 +817,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -702,21 +837,91 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListPhoneNumberCountryResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -728,10 +933,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListPhoneNumberCountry", - "x-maturity": [ - "GA" - ] + "operationId": "ListPhoneNumberCountry" } }, "/v1/PhoneNumbers/Countries/{IsoCountry}": { @@ -746,8 +948,8 @@ "country", "price_unit" ], - "pathType": "instance", - "parent": "/PhoneNumbers" + "parent": "/PhoneNumbers", + "pathType": "instance" }, "get": { "description": "", @@ -772,6 +974,64 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -783,10 +1043,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchPhoneNumberCountry", - "x-maturity": [ - "GA" - ] + "operationId": "FetchPhoneNumberCountry" } }, "/v1/Voice": { @@ -795,7 +1052,7 @@ "url": "https://pricing.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "name" @@ -815,8 +1072,8 @@ "country", "price_unit" ], - "pathType": "list", - "parent": "/Voice" + "parent": "/Voice", + "pathType": "list" }, "get": { "description": "", @@ -866,16 +1123,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -884,21 +1143,91 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListVoiceCountryResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -910,10 +1239,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListVoiceCountry", - "x-maturity": [ - "GA" - ] + "operationId": "ListVoiceCountry" } }, "/v1/Voice/Countries/{IsoCountry}": { @@ -928,8 +1254,8 @@ "country", "price_unit" ], - "pathType": "instance", - "parent": "/Voice" + "parent": "/Voice", + "pathType": "instance" }, "get": { "description": "", @@ -954,6 +1280,74 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -965,10 +1359,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchVoiceCountry", - "x-maturity": [ - "GA" - ] + "operationId": "FetchVoiceCountry" } }, "/v1/Voice/Numbers/{Number}": { @@ -985,8 +1376,8 @@ "inbound_call_price", "price_unit" ], - "pathType": "instance", - "parent": "/Voice" + "parent": "/Voice", + "pathType": "instance" }, "get": { "description": "", @@ -1011,6 +1402,62 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1022,10 +1469,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchVoiceNumber", - "x-maturity": [ - "GA" - ] + "operationId": "FetchVoiceNumber" } }, "/v1/Voice/Numbers": { @@ -1042,8 +1486,8 @@ "inbound_call_price", "price_unit" ], - "pathType": "list", - "parent": "/Voice" + "parent": "/Voice", + "pathType": "list" } } }, @@ -1060,10 +1504,9 @@ "name": "PricingV1Number" } ], - "x-maturity": [ + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_pricing_v2.json b/src/services/twilio-api/twilio_pricing_v2.json index 51a6c846..d4d66f4b 100644 --- a/src/services/twilio-api/twilio_pricing_v2.json +++ b/src/services/twilio-api/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.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -482,16 +482,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -500,21 +502,91 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListTrunkingCountryResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -526,10 +598,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTrunkingCountry", - "x-maturity": [ - "GA" - ] + "operationId": "ListTrunkingCountry" } }, "/v2/Trunking/Countries/{IsoCountry}": { @@ -569,6 +638,115 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -580,10 +758,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTrunkingCountry", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTrunkingCountry" } }, "/v2/Trunking/Numbers/{DestinationNumber}": { @@ -624,6 +799,11 @@ "schema": { "type": "string", "format": "phone-number" + }, + "examples": { + "fetchWithOrigination": { + "value": "+15105556789" + } } } ], @@ -633,6 +813,100 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -644,10 +918,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTrunkingNumber", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTrunkingNumber" } }, "/v2/Trunking/Numbers": { @@ -692,8 +963,8 @@ "country", "price_unit" ], - "pathType": "list", - "parent": "/Voice" + "parent": "/Voice", + "pathType": "list" }, "get": { "description": "", @@ -743,16 +1014,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -761,21 +1034,91 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListVoiceCountryResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -787,10 +1130,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListVoiceCountry", - "x-maturity": [ - "GA" - ] + "operationId": "ListVoiceCountry" } }, "/v2/Voice/Countries/{IsoCountry}": { @@ -805,8 +1145,8 @@ "country", "price_unit" ], - "pathType": "instance", - "parent": "/Voice" + "parent": "/Voice", + "pathType": "instance" }, "get": { "description": "Fetch a specific Country.", @@ -831,6 +1171,115 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -842,10 +1291,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchVoiceCountry", - "x-maturity": [ - "GA" - ] + "operationId": "FetchVoiceCountry" } }, "/v2/Voice/Numbers/{DestinationNumber}": { @@ -861,8 +1307,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.", @@ -887,6 +1333,11 @@ "schema": { "type": "string", "format": "phone-number" + }, + "examples": { + "fetch": { + "value": "+18001234567" + } } } ], @@ -896,6 +1347,68 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -907,10 +1420,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchVoiceNumber", - "x-maturity": [ - "GA" - ] + "operationId": "FetchVoiceNumber" } }, "/v2/Voice/Numbers": { @@ -926,8 +1436,8 @@ "inbound_call_price", "price_unit" ], - "pathType": "list", - "parent": "/Voice" + "parent": "/Voice", + "pathType": "list" } } }, @@ -944,10 +1454,9 @@ "name": "PricingV2Number" } ], - "x-maturity": [ + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_proxy_v1.json b/src/services/twilio-api/twilio_proxy_v1.json index a81aeeb7..33ca738a 100644 --- a/src/services/twilio-api/twilio_proxy_v1.json +++ b/src/services/twilio-api/twilio_proxy_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "proxy.v1.service.session.interaction": { "type": "object", @@ -507,7 +513,12 @@ "capabilities": { "type": "object", "format": "phone-number-capabilities", + "nullable": true, + "description": "The capabilities of the phone number.", "properties": { + "fax": { + "type": "boolean" + }, "mms": { "type": "boolean" }, @@ -516,13 +527,8 @@ }, "voice": { "type": "boolean" - }, - "fax": { - "type": "boolean" } - }, - "nullable": true, - "description": "The capabilities of the phone number." + } }, "url": { "type": "string", @@ -825,7 +831,12 @@ "capabilities": { "type": "object", "format": "phone-number-capabilities", + "nullable": true, + "description": "The capabilities of the short code.", "properties": { + "fax": { + "type": "boolean" + }, "mms": { "type": "boolean" }, @@ -834,13 +845,8 @@ }, "voice": { "type": "boolean" - }, - "fax": { - "type": "boolean" } - }, - "nullable": true, - "description": "The capabilities of the short code." + } }, "url": { "type": "string", @@ -855,12 +861,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -876,7 +876,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -886,15 +886,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).", @@ -945,6 +945,67 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -956,10 +1017,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInteraction", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchInteraction" }, "delete": { "description": "Delete a specific Interaction.", @@ -1014,10 +1072,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteInteraction", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteInteraction" } }, "/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Interactions": { @@ -1026,15 +1081,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.", @@ -1108,16 +1163,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1126,21 +1183,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" } }, "title": "ListInteractionResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1152,10 +1259,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListInteraction", - "x-maturity": [ - "Beta" - ] + "operationId": "ListInteraction" } }, "/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{ParticipantSid}/MessageInteractions": { @@ -1164,15 +1268,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.", @@ -1218,15 +1322,77 @@ } ], "responses": { - "201": { + "200": { "content": { "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" + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" } }, "security": [ @@ -1235,9 +1401,6 @@ } ], "operationId": "CreateMessageInteraction", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1258,6 +1421,13 @@ "description": "Reserved. Not currently supported." } } + }, + "examples": { + "create": { + "value": { + "Body": "some message" + } + } } } } @@ -1268,8 +1438,7 @@ "body", "media_url" ] - ], - "addContentTypeIfEmptyForm": true + ] } }, "get": { @@ -1356,16 +1525,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1374,21 +1545,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" } }, "title": "ListMessageInteractionResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1400,10 +1621,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMessageInteraction", - "x-maturity": [ - "Beta" - ] + "operationId": "ListMessageInteraction" } }, "/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{ParticipantSid}/MessageInteractions/{Sid}": { @@ -1412,15 +1630,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": "", @@ -1483,6 +1701,68 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1494,10 +1774,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMessageInteraction", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchMessageInteraction" } }, "/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{Sid}": { @@ -1506,7 +1783,7 @@ "url": "https://proxy.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -1514,7 +1791,6 @@ "identifier", "proxy_identifier" ], - "pathType": "instance", "dependentProperties": { "message_interactions": { "mapping": { @@ -1525,7 +1801,8 @@ "resource_url": "/v1/Services/{service_sid}/Sessions/{session_sid}/Participants/{participant_sid}/MessageInteractions" } }, - "parent": "/Services/{ServiceSid}/Sessions/{Sid}" + "parent": "/Services/{ServiceSid}/Sessions/{Sid}", + "pathType": "instance" }, "get": { "description": "Fetch a specific Participant.", @@ -1576,6 +1853,82 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1587,10 +1940,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.", @@ -1645,10 +1995,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteParticipant", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteParticipant" } }, "/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants": { @@ -1657,7 +2004,7 @@ "url": "https://proxy.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -1665,7 +2012,6 @@ "identifier", "proxy_identifier" ], - "pathType": "list", "dependentProperties": { "message_interactions": { "mapping": { @@ -1676,7 +2022,8 @@ "resource_url": "/v1/Services/{service_sid}/Sessions/{session_sid}/Participants/{participant_sid}/MessageInteractions" } }, - "parent": "/Services/{ServiceSid}/Sessions/{Sid}" + "parent": "/Services/{ServiceSid}/Sessions/{Sid}", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Participants in a Session.", @@ -1750,16 +2097,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1768,21 +2117,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" } }, "title": "ListParticipantResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1794,10 +2193,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListParticipant", - "x-maturity": [ - "Beta" - ] + "operationId": "ListParticipant" }, "post": { "description": "Add a new Participant to the Session", @@ -1836,6 +2232,82 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1848,9 +2320,6 @@ } ], "operationId": "CreateParticipant", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1881,6 +2350,21 @@ "required": [ "Identifier" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "Identifier": "+14155551212" + } + }, + "createChannel": { + "value": { + "FriendlyName": "a facebook user", + "Identifier": "messenger:123456", + "ProxyIdentifier": "messenger:987654532" + } + } } } } @@ -1893,15 +2377,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.", @@ -1928,21 +2412,75 @@ "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" + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } ], + "operationId": "CreatePhoneNumber", "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1967,12 +2505,16 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -2035,16 +2577,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2053,21 +2597,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" } }, "title": "ListPhoneNumberResponse" + }, + "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 + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2079,10 +2691,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListPhoneNumber", - "x-maturity": [ - "Beta" - ] + "operationId": "ListPhoneNumber" } }, "/v1/Services/{ServiceSid}/PhoneNumbers/{Sid}": { @@ -2091,15 +2700,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.", @@ -2142,10 +2751,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeletePhoneNumber", - "x-maturity": [ - "Beta" - ] + "operationId": "DeletePhoneNumber" }, "get": { "description": "Fetch a specific Phone Number.", @@ -2184,6 +2790,63 @@ "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2195,10 +2858,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchPhoneNumber", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchPhoneNumber" }, "post": { "description": "Update a specific Proxy Number.", @@ -2237,6 +2897,63 @@ "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2249,9 +2966,6 @@ } ], "operationId": "UpdatePhoneNumber", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2264,12 +2978,16 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -2279,14 +2997,13 @@ "url": "https://proxy.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "date_created" ], - "pathType": "instance", "dependentProperties": { "sessions": { "mapping": { @@ -2306,7 +3023,8 @@ }, "resource_url": "/v1/Services/{service_sid}/ShortCodes" } - } + }, + "pathType": "instance" }, "get": { "description": "Fetch a specific Service.", @@ -2330,6 +3048,66 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2341,10 +3119,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchService", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchService" }, "delete": { "description": "Delete a specific Service.", @@ -2375,10 +3150,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteService", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteService" }, "post": { "description": "Update a specific Service.", @@ -2405,6 +3177,66 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2417,9 +3249,6 @@ } ], "operationId": "UpdateService", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2468,12 +3297,19 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -2483,14 +3319,13 @@ "url": "https://proxy.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "date_created" ], - "pathType": "list", "dependentProperties": { "sessions": { "mapping": { @@ -2510,7 +3345,8 @@ }, "resource_url": "/v1/Services/{service_sid}/ShortCodes" } - } + }, + "pathType": "list" }, "get": { "description": "Retrieve a list of all Services for Twilio Proxy. A maximum of 100 records will be returned per page.", @@ -2560,16 +3396,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2578,21 +3416,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" } }, "title": "ListServiceResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2604,10 +3492,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListService", - "x-maturity": [ - "Beta" - ] + "operationId": "ListService" }, "post": { "description": "Create a new Service for Twilio Proxy", @@ -2620,6 +3505,66 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2632,9 +3577,6 @@ } ], "operationId": "CreateService", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2686,6 +3628,16 @@ "required": [ "UniqueName" ] + }, + "examples": { + "create": { + "value": { + "DefaultTtl": 3600, + "CallbackUrl": "http://www.example.com", + "UniqueName": "My Service", + "ChatInstanceSid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -2698,7 +3650,7 @@ "url": "https://proxy.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2706,7 +3658,6 @@ "date_started", "date_ended" ], - "pathType": "instance", "dependentProperties": { "interactions": { "mapping": { @@ -2723,7 +3674,8 @@ "resource_url": "/v1/Services/{service_sid}/Sessions/{session_sid}/Participants" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "Fetch a specific Session.", @@ -2759,6 +3711,67 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2770,10 +3783,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSession", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchSession" }, "delete": { "description": "Delete a specific Session.", @@ -2816,10 +3826,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSession", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteSession" }, "post": { "description": "Update a specific Session.", @@ -2858,6 +3865,67 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2870,9 +3938,6 @@ } ], "operationId": "UpdateSession", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2895,12 +3960,17 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -2910,7 +3980,7 @@ "url": "https://proxy.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2918,7 +3988,6 @@ "date_started", "date_ended" ], - "pathType": "list", "dependentProperties": { "interactions": { "mapping": { @@ -2935,7 +4004,8 @@ "resource_url": "/v1/Services/{service_sid}/Sessions/{session_sid}/Participants" } }, - "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.", @@ -2997,16 +4067,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3015,21 +4087,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" } }, "title": "ListSessionResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3041,10 +4163,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSession", - "x-maturity": [ - "Beta" - ] + "operationId": "ListSession" }, "post": { "description": "Create a new Session", @@ -3071,6 +4190,67 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3083,9 +4263,6 @@ } ], "operationId": "CreateSession", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3122,12 +4299,17 @@ "description": "The Participant objects to include in the new session." } } + }, + "examples": { + "create": { + "value": { + "Ttl": 3600, + "UniqueName": "Order #1234" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -3137,15 +4319,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.", @@ -3172,6 +4354,61 @@ "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3184,9 +4421,6 @@ } ], "operationId": "CreateShortCode", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3205,6 +4439,13 @@ "required": [ "Sid" ] + }, + "examples": { + "create": { + "value": { + "Sid": "SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -3270,16 +4511,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3288,21 +4531,87 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListShortCodeResponse" + }, + "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 + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3314,10 +4623,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListShortCode", - "x-maturity": [ - "Beta" - ] + "operationId": "ListShortCode" } }, "/v1/Services/{ServiceSid}/ShortCodes/{Sid}": { @@ -3326,15 +4632,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.", @@ -3377,10 +4683,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteShortCode", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteShortCode" }, "get": { "description": "Fetch a specific Short Code.", @@ -3419,6 +4722,61 @@ "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3430,10 +4788,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchShortCode", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchShortCode" }, "post": { "description": "Update a specific Short Code.", @@ -3472,6 +4827,61 @@ "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3484,9 +4894,6 @@ } ], "operationId": "UpdateShortCode", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3499,12 +4906,16 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } } @@ -3537,10 +4948,9 @@ "name": "ProxyV1ShortCode" } ], - "x-maturity": [ + "security": [ { - "name": "Beta", - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_routes_v2.json b/src/services/twilio-api/twilio_routes_v2.json index fc2fe5b2..1a86e521 100644 --- a/src/services/twilio-api/twilio_routes_v2.json +++ b/src/services/twilio-api/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.56.1" + "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", @@ -217,6 +217,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -229,9 +279,6 @@ } ], "operationId": "UpdatePhoneNumber", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -248,12 +295,17 @@ "description": "A human readable description of this resource, up to 64 characters." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "VoiceRegion": "au1" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -278,6 +330,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -289,10 +391,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchPhoneNumber", - "x-maturity": [ - "GA" - ] + "operationId": "FetchPhoneNumber" } }, "/v2/SipDomains/{SipDomain}": { @@ -301,7 +400,7 @@ "url": "https://routes.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -332,6 +431,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -344,9 +493,6 @@ } ], "operationId": "UpdateSipDomain", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -363,12 +509,17 @@ "description": "" } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "VoiceRegion": "au1" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -393,6 +544,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -404,10 +605,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSipDomain", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSipDomain" } }, "/v2/Trunks/{SipTrunkDomain}": { @@ -416,7 +614,7 @@ "url": "https://routes.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -447,6 +645,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -459,9 +707,6 @@ } ], "operationId": "UpdateTrunks", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -478,12 +723,17 @@ "description": "A human readable description of this resource, up to 64 characters." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "friendly_name", + "VoiceRegion": "au1" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -508,6 +758,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -519,10 +819,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTrunks", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTrunks" } } }, @@ -542,10 +839,9 @@ "name": "RoutesV2Trunk" } ], - "x-maturity": [ + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_serverless_v1.json b/src/services/twilio-api/twilio_serverless_v1.json index 3c8f601a..e38f7e92 100644 --- a/src/services/twilio-api/twilio_serverless_v1.json +++ b/src/services/twilio-api/twilio_serverless_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "serverless.v1.service.asset": { "type": "object", @@ -895,12 +901,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -916,7 +916,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -933,7 +933,6 @@ "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { "asset_versions": { "mapping": { @@ -943,7 +942,8 @@ "resource_url": "/v1/Services/{service_sid}/Assets/{asset_sid}/Versions" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Assets.", @@ -1002,16 +1002,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1020,21 +1022,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" } }, "title": "ListAssetResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1046,10 +1098,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAsset", - "x-maturity": [ - "Beta" - ] + "operationId": "ListAsset" }, "post": { "description": "Create a new Asset resource.", @@ -1073,6 +1122,58 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1085,9 +1186,6 @@ } ], "operationId": "CreateAsset", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1103,6 +1201,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "asset-friendly" + } + } } } } @@ -1122,7 +1227,6 @@ "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { "asset_versions": { "mapping": { @@ -1132,7 +1236,8 @@ "resource_url": "/v1/Services/{service_sid}/Assets/{asset_sid}/Versions" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "Retrieve a specific Asset resource.", @@ -1168,6 +1273,58 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1179,10 +1336,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAsset", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchAsset" }, "delete": { "description": "Delete an Asset resource.", @@ -1222,10 +1376,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteAsset", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteAsset" }, "post": { "description": "Update a specific Asset resource.", @@ -1261,6 +1412,58 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1273,9 +1476,6 @@ } ], "operationId": "UpdateAsset", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1291,6 +1491,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "update": { + "value": { + "FriendlyName": "asset-friendly-update" + } + } } } } @@ -1311,9 +1518,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.", @@ -1384,16 +1591,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1402,21 +1611,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" } }, "title": "ListAssetVersionResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1428,10 +1687,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAssetVersion", - "x-maturity": [ - "Beta" - ] + "operationId": "ListAssetVersion" } }, "/v1/Services/{ServiceSid}/Assets/{AssetSid}/Versions/{Sid}": { @@ -1448,9 +1704,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.", @@ -1498,6 +1754,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1509,10 +1815,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAssetVersion", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchAssetVersion" } }, "/v1/Services/{ServiceSid}/Builds": { @@ -1528,7 +1831,6 @@ "status", "date_created" ], - "pathType": "list", "dependentProperties": { "build_status": { "mapping": { @@ -1538,7 +1840,8 @@ "resource_url": "/v1/Services/{service_sid}/Builds/{sid}/Status" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Builds.", @@ -1597,16 +1900,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1615,21 +1920,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" } }, "title": "ListBuildResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1641,10 +1996,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.", @@ -1668,6 +2020,91 @@ "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": "node18", + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1680,9 +2117,6 @@ } ], "operationId": "CreateBuild", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1719,12 +2153,22 @@ "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\"}]" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -1741,7 +2185,6 @@ "status", "date_created" ], - "pathType": "instance", "dependentProperties": { "build_status": { "mapping": { @@ -1751,7 +2194,8 @@ "resource_url": "/v1/Services/{service_sid}/Builds/{sid}/Status" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "Retrieve a specific Build resource.", @@ -1787,6 +2231,91 @@ "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": "node18", + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1798,10 +2327,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchBuild", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchBuild" }, "delete": { "description": "Delete a Build resource.", @@ -1841,10 +2367,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteBuild", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteBuild" } }, "/v1/Services/{ServiceSid}/Builds/{Sid}/Status": { @@ -1859,9 +2382,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.", @@ -1897,6 +2420,53 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1908,10 +2478,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchBuildStatus", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchBuildStatus" } }, "/v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Deployments": { @@ -1927,8 +2494,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.", @@ -1999,16 +2566,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2017,21 +2586,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" } }, "title": "ListDeploymentResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2043,10 +2662,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListDeployment", - "x-maturity": [ - "Beta" - ] + "operationId": "ListDeployment" }, "post": { "description": "Create a new Deployment.", @@ -2082,8 +2698,58 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } }, "description": "Created" } @@ -2094,9 +2760,6 @@ } ], "operationId": "CreateDeployment", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2112,12 +2775,16 @@ "description": "The SID of the Build for the Deployment." } } + }, + "examples": { + "create": { + "value": { + "BuildSid": "ZB00000000000000000000000000000000" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -2134,8 +2801,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.", @@ -2183,6 +2850,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2194,10 +2911,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDeployment", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchDeployment" } }, "/v1/Services/{ServiceSid}/Environments": { @@ -2214,7 +2928,6 @@ "domain_name", "build_sid" ], - "pathType": "list", "dependentProperties": { "variables": { "mapping": { @@ -2238,7 +2951,8 @@ "resource_url": "/v1/Services/{service_sid}/Environments/{environment_sid}/Logs" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "get": { "description": "Retrieve a list of all environments.", @@ -2297,16 +3011,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2315,21 +3031,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" } }, "title": "ListEnvironmentResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2341,10 +3107,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListEnvironment", - "x-maturity": [ - "Beta" - ] + "operationId": "ListEnvironment" }, "post": { "description": "Create a new environment.", @@ -2368,6 +3131,64 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2380,9 +3201,6 @@ } ], "operationId": "CreateEnvironment", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2402,6 +3220,14 @@ "required": [ "UniqueName" ] + }, + "examples": { + "create": { + "value": { + "UniqueName": "staging", + "DomainSuffix": "stage" + } + } } } } @@ -2422,7 +3248,6 @@ "domain_name", "build_sid" ], - "pathType": "instance", "dependentProperties": { "variables": { "mapping": { @@ -2446,7 +3271,8 @@ "resource_url": "/v1/Services/{service_sid}/Environments/{environment_sid}/Logs" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "Retrieve a specific environment.", @@ -2482,6 +3308,64 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2493,10 +3377,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEnvironment", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchEnvironment" }, "delete": { "description": "Delete a specific environment.", @@ -2536,10 +3417,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteEnvironment", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteEnvironment" } }, "/v1/Services/{ServiceSid}/Functions": { @@ -2555,7 +3433,6 @@ "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { "function_versions": { "mapping": { @@ -2565,7 +3442,8 @@ "resource_url": "/v1/Services/{service_sid}/Functions/{function_sid}/Versions" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Functions.", @@ -2624,16 +3502,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2642,21 +3522,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" } }, "title": "ListFunctionResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2668,10 +3598,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListFunction", - "x-maturity": [ - "Beta" - ] + "operationId": "ListFunction" }, "post": { "description": "Create a new Function resource.", @@ -2695,6 +3622,58 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2707,9 +3686,6 @@ } ], "operationId": "CreateFunction", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2725,6 +3701,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "function-friendly" + } + } } } } @@ -2744,7 +3727,6 @@ "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { "function_versions": { "mapping": { @@ -2754,7 +3736,8 @@ "resource_url": "/v1/Services/{service_sid}/Functions/{function_sid}/Versions" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "Retrieve a specific Function resource.", @@ -2790,6 +3773,58 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2801,10 +3836,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchFunction", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchFunction" }, "delete": { "description": "Delete a Function resource.", @@ -2844,10 +3876,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteFunction", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteFunction" }, "post": { "description": "Update a specific Function resource.", @@ -2883,6 +3912,58 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2895,9 +3976,6 @@ } ], "operationId": "UpdateFunction", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2913,6 +3991,13 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "update": { + "value": { + "FriendlyName": "function-friendly-update" + } + } } } } @@ -2933,7 +4018,6 @@ "visibility", "date_created" ], - "pathType": "list", "dependentProperties": { "function_version_content": { "mapping": { @@ -2945,7 +4029,8 @@ } }, "parent": "/Services/{ServiceSid}/Functions/{Sid}", - "mountName": "function_versions" + "mountName": "function_versions", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Function Version resources.", @@ -3016,16 +4101,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3034,21 +4121,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" } }, "title": "ListFunctionVersionResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3060,10 +4197,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListFunctionVersion", - "x-maturity": [ - "Beta" - ] + "operationId": "ListFunctionVersion" } }, "/v1/Services/{ServiceSid}/Functions/{FunctionSid}/Versions/{Sid}": { @@ -3080,7 +4214,6 @@ "visibility", "date_created" ], - "pathType": "instance", "dependentProperties": { "function_version_content": { "mapping": { @@ -3092,7 +4225,8 @@ } }, "parent": "/Services/{ServiceSid}/Functions/{Sid}", - "mountName": "function_versions" + "mountName": "function_versions", + "pathType": "instance" }, "get": { "description": "Retrieve a specific Function Version resource.", @@ -3140,6 +4274,59 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3151,10 +4338,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchFunctionVersion", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchFunctionVersion" } }, "/v1/Services/{ServiceSid}/Functions/{FunctionSid}/Versions/{Sid}/Content": { @@ -3169,9 +4353,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.", @@ -3219,6 +4403,54 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3230,10 +4462,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchFunctionVersionContent", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchFunctionVersionContent" } }, "/v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Logs": { @@ -3245,8 +4474,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.", @@ -3284,6 +4513,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^ZH[0-9a-fA-F]{32}$" + }, + "examples": { + "readEmpty": { + "value": "ZH00000000000000000000000000000000" + } } }, { @@ -3293,6 +4527,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readEmpty": { + "value": "2018-11-10T20:00:00Z" + } } }, { @@ -3302,6 +4541,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readEmpty": { + "value": "2018-12-10T20:00:00Z" + } } }, { @@ -3346,16 +4590,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3364,21 +4610,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" } }, "title": "ListLogResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3390,10 +4686,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListLog", - "x-maturity": [ - "Beta" - ] + "operationId": "ListLog" } }, "/v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Logs/{Sid}": { @@ -3405,8 +4698,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.", @@ -3454,6 +4747,60 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3465,10 +4812,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchLog", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchLog" } }, "/v1/Services": { @@ -3484,7 +4828,6 @@ "unique_name", "friendly_name" ], - "pathType": "list", "dependentProperties": { "environments": { "mapping": { @@ -3510,7 +4853,8 @@ }, "resource_url": "/v1/Services/{service_sid}/Builds" } - } + }, + "pathType": "list" }, "get": { "description": "Retrieve a list of all Services.", @@ -3560,16 +4904,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3578,21 +4924,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" } }, "title": "ListServiceResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3604,10 +5000,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListService", - "x-maturity": [ - "Beta" - ] + "operationId": "ListService" }, "post": { "description": "Create a new Service resource.", @@ -3620,6 +5013,64 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3632,9 +5083,6 @@ } ], "operationId": "CreateService", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3663,6 +5111,14 @@ "UniqueName", "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "service-friendly", + "UniqueName": "service-unique" + } + } } } } @@ -3682,7 +5138,6 @@ "unique_name", "friendly_name" ], - "pathType": "instance", "dependentProperties": { "environments": { "mapping": { @@ -3708,7 +5163,8 @@ }, "resource_url": "/v1/Services/{service_sid}/Builds" } - } + }, + "pathType": "instance" }, "get": { "description": "Retrieve a specific Service resource.", @@ -3732,6 +5188,64 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3743,10 +5257,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchService", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchService" }, "delete": { "description": "Delete a Service resource.", @@ -3774,10 +5285,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteService", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteService" }, "post": { "description": "Update a specific Service resource.", @@ -3801,6 +5309,64 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3813,9 +5379,6 @@ } ], "operationId": "UpdateService", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3836,12 +5399,18 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -3858,8 +5427,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.", @@ -3930,16 +5499,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3948,21 +5519,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" } }, "title": "ListVariableResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3974,10 +5595,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListVariable", - "x-maturity": [ - "Beta" - ] + "operationId": "ListVariable" }, "post": { "description": "Create a new Variable.", @@ -4013,6 +5631,57 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4025,9 +5694,6 @@ } ], "operationId": "CreateVariable", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4048,6 +5714,14 @@ "Key", "Value" ] + }, + "examples": { + "create": { + "value": { + "Key": "new-key", + "Value": "new-value" + } + } } } } @@ -4067,8 +5741,8 @@ "key", "date_created" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Environments/{Sid}" + "parent": "/Services/{ServiceSid}/Environments/{Sid}", + "pathType": "instance" }, "get": { "description": "Retrieve a specific Variable.", @@ -4116,6 +5790,57 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4127,10 +5852,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchVariable", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchVariable" }, "post": { "description": "Update a specific Variable.", @@ -4178,6 +5900,57 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4190,9 +5963,6 @@ } ], "operationId": "UpdateVariable", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4209,12 +5979,17 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -4267,10 +6042,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteVariable", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteVariable" } } }, @@ -4317,10 +6089,9 @@ "name": "ServerlessV1Variable" } ], - "x-maturity": [ + "security": [ { - "name": "Beta", - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_studio_v1.json b/src/services/twilio-api/twilio_studio_v1.json index 93ef48df..2370b74c 100644 --- a/src/services/twilio-api/twilio_studio_v1.json +++ b/src/services/twilio-api/twilio_studio_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "studio.v1.flow.engagement": { "type": "object", @@ -609,12 +615,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -630,7 +630,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -648,7 +648,6 @@ "status", "date_created" ], - "pathType": "list", "dependentProperties": { "steps": { "mapping": { @@ -665,7 +664,8 @@ "resource_url": "/v1/Flows/{flow_sid}/Engagements/{engagement_sid}/Context" } }, - "parent": "/Flows/{Sid}" + "parent": "/Flows/{Sid}", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Engagements for the Flow.", @@ -727,16 +727,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -745,21 +747,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" } }, "title": "ListEngagementResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -771,10 +823,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListEngagement", - "x-maturity": [ - "GA" - ] + "operationId": "ListEngagement" }, "post": { "description": "Triggers a new Engagement for the Flow", @@ -801,6 +850,62 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -813,9 +918,6 @@ } ], "operationId": "CreateEngagement", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -841,6 +943,15 @@ "To", "From" ] + }, + "examples": { + "create": { + "value": { + "To": "+18001234567", + "From": "+18007654321", + "Parameters": "{\"first_name\":\"Foo\"}" + } + } } } } @@ -861,7 +972,6 @@ "status", "date_created" ], - "pathType": "instance", "dependentProperties": { "steps": { "mapping": { @@ -878,7 +988,8 @@ "resource_url": "/v1/Flows/{flow_sid}/Engagements/{engagement_sid}/Context" } }, - "parent": "/Flows/{Sid}" + "parent": "/Flows/{Sid}", + "pathType": "instance" }, "get": { "description": "Retrieve an Engagement", @@ -917,6 +1028,62 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -928,10 +1095,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEngagement", - "x-maturity": [ - "GA" - ] + "operationId": "FetchEngagement" }, "delete": { "description": "Delete this Engagement and all Steps relating to it.", @@ -974,10 +1138,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteEngagement", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteEngagement" } }, "/v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Context": { @@ -991,9 +1152,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.", @@ -1032,6 +1193,55 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1043,10 +1253,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEngagementContext", - "x-maturity": [ - "GA" - ] + "operationId": "FetchEngagementContext" } }, "/v1/Flows/{FlowSid}/Executions": { @@ -1063,7 +1270,6 @@ "status", "date_created" ], - "pathType": "list", "dependentProperties": { "steps": { "mapping": { @@ -1080,7 +1286,8 @@ "resource_url": "/v1/Flows/{flow_sid}/Executions/{execution_sid}/Context" } }, - "parent": "/Flows/{Sid}" + "parent": "/Flows/{Sid}", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Executions for the Flow.", @@ -1160,16 +1367,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1178,21 +1387,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" } }, "title": "ListExecutionResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1204,10 +1463,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListExecution", - "x-maturity": [ - "GA" - ] + "operationId": "ListExecution" }, "post": { "description": "Triggers a new Execution for the Flow", @@ -1234,6 +1490,62 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1246,9 +1558,6 @@ } ], "operationId": "CreateExecution", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1274,6 +1583,15 @@ "To", "From" ] + }, + "examples": { + "create": { + "value": { + "To": "+18001234567", + "From": "+18007654321", + "Parameters": "{\"first_name\":\"Foo\"}" + } + } } } } @@ -1294,7 +1612,6 @@ "status", "date_created" ], - "pathType": "instance", "dependentProperties": { "steps": { "mapping": { @@ -1311,7 +1628,8 @@ "resource_url": "/v1/Flows/{flow_sid}/Executions/{execution_sid}/Context" } }, - "parent": "/Flows/{Sid}" + "parent": "/Flows/{Sid}", + "pathType": "instance" }, "get": { "description": "Retrieve an Execution", @@ -1350,6 +1668,62 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1361,10 +1735,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchExecution", - "x-maturity": [ - "GA" - ] + "operationId": "FetchExecution" }, "delete": { "description": "Delete the Execution and all Steps relating to it.", @@ -1407,10 +1778,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteExecution", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteExecution" }, "post": { "description": "Update the status of an Execution to `ended`.", @@ -1449,6 +1817,62 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1461,9 +1885,6 @@ } ], "operationId": "UpdateExecution", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1480,6 +1901,13 @@ "required": [ "Status" ] + }, + "examples": { + "update": { + "value": { + "Status": "ended" + } + } } } } @@ -1497,9 +1925,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.", @@ -1538,6 +1966,55 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1549,10 +2026,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchExecutionContext", - "x-maturity": [ - "GA" - ] + "operationId": "FetchExecutionContext" } }, "/v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps": { @@ -1568,7 +2042,6 @@ "name", "date_created" ], - "pathType": "list", "dependentProperties": { "step_context": { "mapping": { @@ -1580,7 +2053,8 @@ } }, "parent": "/Flows/{FlowSid}/Executions/{Sid}", - "className": "execution_step" + "className": "execution_step", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Steps for an Execution.", @@ -1654,16 +2128,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1672,21 +2148,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" } }, "title": "ListExecutionStepResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1698,10 +2224,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListExecutionStep", - "x-maturity": [ - "GA" - ] + "operationId": "ListExecutionStep" } }, "/v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{Sid}": { @@ -1717,7 +2240,6 @@ "name", "date_created" ], - "pathType": "instance", "dependentProperties": { "step_context": { "mapping": { @@ -1729,7 +2251,8 @@ } }, "parent": "/Flows/{FlowSid}/Executions/{Sid}", - "className": "execution_step" + "className": "execution_step", + "pathType": "instance" }, "get": { "description": "Retrieve a Step.", @@ -1780,6 +2303,63 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1791,10 +2371,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchExecutionStep", - "x-maturity": [ - "GA" - ] + "operationId": "FetchExecutionStep" } }, "/v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{StepSid}/Context": { @@ -1808,10 +2385,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.", @@ -1862,6 +2439,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1873,10 +2500,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchExecutionStepContext", - "x-maturity": [ - "GA" - ] + "operationId": "FetchExecutionStepContext" } }, "/v1/Flows": { @@ -1893,7 +2517,6 @@ "status", "version" ], - "pathType": "list", "dependentProperties": { "engagements": { "mapping": { @@ -1907,7 +2530,8 @@ }, "resource_url": "/v1/Flows/{flow_sid}/Executions" } - } + }, + "pathType": "list" }, "get": { "description": "Retrieve a list of all Flows.", @@ -1957,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" @@ -1975,21 +2601,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" } }, "title": "ListFlowResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2001,10 +2677,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListFlow", - "x-maturity": [ - "GA" - ] + "operationId": "ListFlow" } }, "/v1/Flows/{Sid}": { @@ -2021,7 +2694,6 @@ "status", "version" ], - "pathType": "instance", "dependentProperties": { "engagements": { "mapping": { @@ -2035,7 +2707,8 @@ }, "resource_url": "/v1/Flows/{flow_sid}/Executions" } - } + }, + "pathType": "instance" }, "get": { "description": "Retrieve a specific Flow.", @@ -2062,6 +2735,60 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2073,10 +2800,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchFlow", - "x-maturity": [ - "GA" - ] + "operationId": "FetchFlow" }, "delete": { "description": "Delete a specific Flow.", @@ -2107,10 +2831,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteFlow", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteFlow" } }, "/v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Steps": { @@ -2127,7 +2848,6 @@ "transitioned_from", "transitioned_to" ], - "pathType": "list", "dependentProperties": { "step_context": { "mapping": { @@ -2138,7 +2858,8 @@ "resource_url": "/v1/Flows/{flow_sid}/Engagements/{engagement_sid}/Steps/{step_sid}/Context" } }, - "parent": "/Flows/{FlowSid}/Engagements/{Sid}" + "parent": "/Flows/{FlowSid}/Engagements/{Sid}", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Steps for an Engagement.", @@ -2212,16 +2933,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2230,21 +2953,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" } }, "title": "ListStepResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2256,10 +3029,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListStep", - "x-maturity": [ - "GA" - ] + "operationId": "ListStep" } }, "/v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Steps/{Sid}": { @@ -2276,7 +3046,6 @@ "transitioned_from", "transitioned_to" ], - "pathType": "instance", "dependentProperties": { "step_context": { "mapping": { @@ -2287,7 +3056,8 @@ "resource_url": "/v1/Flows/{flow_sid}/Engagements/{engagement_sid}/Steps/{step_sid}/Context" } }, - "parent": "/Flows/{FlowSid}/Engagements/{Sid}" + "parent": "/Flows/{FlowSid}/Engagements/{Sid}", + "pathType": "instance" }, "get": { "description": "Retrieve a Step.", @@ -2338,6 +3108,62 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2349,10 +3175,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchStep", - "x-maturity": [ - "GA" - ] + "operationId": "FetchStep" } }, "/v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Steps/{StepSid}/Context": { @@ -2366,9 +3189,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.", @@ -2419,6 +3242,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2430,10 +3303,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchStepContext", - "x-maturity": [ - "GA" - ] + "operationId": "FetchStepContext" } } }, @@ -2471,10 +3341,9 @@ "name": "StudioV1StepContext" } ], - "x-maturity": [ + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_studio_v2.json b/src/services/twilio-api/twilio_studio_v2.json index a28dd21d..d1ef5ba5 100644 --- a/src/services/twilio-api/twilio_studio_v2.json +++ b/src/services/twilio-api/twilio_studio_v2.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "studio.v2.flow.execution": { "type": "object", @@ -497,12 +503,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -518,7 +518,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -535,7 +535,6 @@ "status", "date_created" ], - "pathType": "list", "dependentProperties": { "steps": { "mapping": { @@ -552,7 +551,8 @@ "resource_url": "/v2/Flows/{flow_sid}/Executions/{execution_sid}/Context" } }, - "parent": "/Flows/{Sid}" + "parent": "/Flows/{Sid}", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Executions for the Flow.", @@ -632,16 +632,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -650,21 +652,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" } }, "title": "ListExecutionResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -676,10 +728,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListExecution", - "x-maturity": [ - "GA" - ] + "operationId": "ListExecution" }, "post": { "description": "Triggers a new Execution for the Flow", @@ -706,6 +755,61 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -718,9 +822,6 @@ } ], "operationId": "CreateExecution", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -746,6 +847,15 @@ "To", "From" ] + }, + "examples": { + "create": { + "value": { + "To": "+18001234567", + "From": "+18007654321", + "Parameters": "{\"first_name\":\"Foo\"}" + } + } } } } @@ -765,7 +875,6 @@ "status", "date_created" ], - "pathType": "instance", "dependentProperties": { "steps": { "mapping": { @@ -782,7 +891,8 @@ "resource_url": "/v2/Flows/{flow_sid}/Executions/{execution_sid}/Context" } }, - "parent": "/Flows/{Sid}" + "parent": "/Flows/{Sid}", + "pathType": "instance" }, "get": { "description": "Retrieve an Execution", @@ -821,6 +931,61 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -832,10 +997,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchExecution", - "x-maturity": [ - "GA" - ] + "operationId": "FetchExecution" }, "delete": { "description": "Delete the Execution and all Steps relating to it.", @@ -878,10 +1040,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteExecution", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteExecution" }, "post": { "description": "Update the status of an Execution to `ended`.", @@ -920,6 +1079,61 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -932,9 +1146,6 @@ } ], "operationId": "UpdateExecution", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -951,6 +1162,13 @@ "required": [ "Status" ] + }, + "examples": { + "update": { + "value": { + "Status": "ended" + } + } } } } @@ -968,9 +1186,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.", @@ -1009,6 +1227,55 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1020,10 +1287,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchExecutionContext", - "x-maturity": [ - "GA" - ] + "operationId": "FetchExecutionContext" } }, "/v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps": { @@ -1039,7 +1303,6 @@ "name", "date_created" ], - "pathType": "list", "dependentProperties": { "step_context": { "mapping": { @@ -1051,7 +1314,8 @@ } }, "parent": "/Flows/{FlowSid}/Executions/{Sid}", - "className": "execution_step" + "className": "execution_step", + "pathType": "list" }, "get": { "description": "Retrieve a list of all Steps for an Execution.", @@ -1125,16 +1389,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1143,21 +1409,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" } }, "title": "ListExecutionStepResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1169,10 +1485,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListExecutionStep", - "x-maturity": [ - "GA" - ] + "operationId": "ListExecutionStep" } }, "/v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{Sid}": { @@ -1188,7 +1501,6 @@ "name", "date_created" ], - "pathType": "instance", "dependentProperties": { "step_context": { "mapping": { @@ -1200,7 +1512,8 @@ } }, "parent": "/Flows/{FlowSid}/Executions/{Sid}", - "className": "execution_step" + "className": "execution_step", + "pathType": "instance" }, "get": { "description": "Retrieve a Step.", @@ -1251,6 +1564,63 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1262,10 +1632,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchExecutionStep", - "x-maturity": [ - "GA" - ] + "operationId": "FetchExecutionStep" } }, "/v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{StepSid}/Context": { @@ -1279,10 +1646,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.", @@ -1333,6 +1700,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1344,10 +1761,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchExecutionStepContext", - "x-maturity": [ - "GA" - ] + "operationId": "FetchExecutionStepContext" } }, "/v2/Flows": { @@ -1364,7 +1778,6 @@ "status", "revision" ], - "pathType": "list", "dependentProperties": { "revisions": { "mapping": { @@ -1384,7 +1797,8 @@ }, "resource_url": "/v2/Flows/{flow_sid}/Executions" } - } + }, + "pathType": "list" }, "post": { "description": "Create a Flow.", @@ -1397,6 +1811,69 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1409,9 +1886,6 @@ } ], "operationId": "CreateFlow", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1441,6 +1915,15 @@ "Status", "Definition" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "Test Flow", + "Status": "published", + "Definition": "{\"initial_state\": \"Trigger\"}" + } + } } } } @@ -1494,16 +1977,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1512,21 +1997,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" } }, "title": "ListFlowResponse" + }, + "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" + } + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1538,10 +2095,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListFlow", - "x-maturity": [ - "GA" - ] + "operationId": "ListFlow" } }, "/v2/Flows/{Sid}": { @@ -1558,7 +2112,6 @@ "status", "revision" ], - "pathType": "instance", "dependentProperties": { "revisions": { "mapping": { @@ -1578,7 +2131,8 @@ }, "resource_url": "/v2/Flows/{flow_sid}/Executions" } - } + }, + "pathType": "instance" }, "post": { "description": "Update a Flow.", @@ -1605,6 +2159,69 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1617,9 +2234,6 @@ } ], "operationId": "UpdateFlow", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1647,6 +2261,15 @@ "required": [ "Status" ] + }, + "examples": { + "update": { + "value": { + "FriendlyName": "Test Flow", + "Status": "published", + "Definition": "{\"initial_state\": \"Trigger\"}" + } + } } } } @@ -1677,6 +2300,69 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1688,10 +2374,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchFlow", - "x-maturity": [ - "GA" - ] + "operationId": "FetchFlow" }, "delete": { "description": "Delete a specific Flow.", @@ -1722,10 +2405,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteFlow", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteFlow" } }, "/v2/Flows/{Sid}/Revisions": { @@ -1742,9 +2422,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.", @@ -1806,16 +2486,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1824,21 +2506,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" } }, "title": "ListFlowRevisionResponse" + }, + "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" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1850,10 +2597,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListFlowRevision", - "x-maturity": [ - "GA" - ] + "operationId": "ListFlowRevision" } }, "/v2/Flows/{Sid}/Revisions/{Revision}": { @@ -1870,9 +2614,9 @@ "status", "revision" ], - "pathType": "instance", "parent": "/Flows/{Sid}", - "className": "flow_revision" + "className": "flow_revision", + "pathType": "instance" }, "get": { "description": "Retrieve a specific Flow revision.", @@ -1908,6 +2652,62 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1919,10 +2719,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchFlowRevision", - "x-maturity": [ - "GA" - ] + "operationId": "FetchFlowRevision" } }, "/v2/Flows/Validate": { @@ -1936,8 +2733,8 @@ "defaultOutputProperties": [ "valid" ], - "pathType": "list", - "mountName": "flow_validate" + "mountName": "flow_validate", + "pathType": "list" }, "post": { "description": "Validate flow JSON definition", @@ -1950,6 +2747,49 @@ "application/json": { "schema": { "$ref": "#/components/schemas/studio.v2.flow_validate" + }, + "examples": { + "update": { + "value": { + "valid": true + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1962,9 +2802,6 @@ } ], "operationId": "UpdateFlowValidate", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1994,6 +2831,15 @@ "Status", "Definition" ] + }, + "examples": { + "update": { + "value": { + "FriendlyName": "Test Flow", + "Status": "published", + "Definition": "{\"initial_state\": \"Trigger\"}" + } + } } } } @@ -2011,9 +2857,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", @@ -2040,6 +2886,54 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2051,10 +2945,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTestUser", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTestUser" }, "post": { "description": "Update flow test users", @@ -2081,6 +2972,54 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2093,9 +3032,6 @@ } ], "operationId": "UpdateTestUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2114,6 +3050,16 @@ "required": [ "TestUsers" ] + }, + "examples": { + "update": { + "value": { + "TestUsers": [ + "user1", + "user2" + ] + } + } } } } @@ -2127,6 +3073,9 @@ } ], "tags": [ + { + "name": "StudioV2Application" + }, { "name": "StudioV2Execution" }, @@ -2152,10 +3101,9 @@ "name": "StudioV2FlowValidate" } ], - "x-maturity": [ + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_supersim_v1.json b/src/services/twilio-api/twilio_supersim_v1.json index f978d5db..fa90b247 100644 --- a/src/services/twilio-api/twilio_supersim_v1.json +++ b/src/services/twilio-api/twilio_supersim_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "supersim.v1.sim.billing_period": { "type": "object", @@ -891,12 +897,6 @@ "time" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -912,7 +912,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -931,8 +931,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.", @@ -991,16 +991,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1009,21 +1011,121 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListBillingPeriodResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1035,10 +1137,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListBillingPeriod", - "x-maturity": [ - "GA" - ] + "operationId": "ListBillingPeriod" } }, "/v1/ESimProfiles": { @@ -1053,8 +1152,8 @@ "sid", "status" ], - "pathType": "list", - "mountName": "esim_profiles" + "mountName": "esim_profiles", + "pathType": "list" }, "post": { "description": "Order an eSIM Profile.", @@ -1067,6 +1166,98 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1079,9 +1270,6 @@ } ], "operationId": "CreateEsimProfile", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1111,12 +1299,28 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -1131,6 +1335,11 @@ "description": "List the eSIM Profiles that have been associated with an EId.", "schema": { "type": "string" + }, + "examples": { + "readByEid": { + "value": "89049032005008882600033489aaaaaa" + } } }, { @@ -1139,6 +1348,11 @@ "description": "Find the eSIM Profile resource related to a [Sim](https://www.twilio.com/docs/iot/supersim/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" + } } }, { @@ -1148,6 +1362,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/esim_profile_enum_status" + }, + "examples": { + "readByStatus": { + "value": "downloaded" + } } }, { @@ -1192,16 +1411,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1210,21 +1431,181 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListEsimProfileResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1236,10 +1617,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListEsimProfile", - "x-maturity": [ - "Beta" - ] + "operationId": "ListEsimProfile" } }, "/v1/ESimProfiles/{Sid}": { @@ -1254,8 +1632,8 @@ "sid", "status" ], - "pathType": "instance", - "mountName": "esim_profiles" + "mountName": "esim_profiles", + "pathType": "instance" }, "get": { "description": "Fetch an eSIM Profile.", @@ -1279,6 +1657,80 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1290,10 +1742,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEsimProfile", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchEsimProfile" } }, "/v1/Fleets": { @@ -1322,6 +1771,63 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1334,9 +1840,6 @@ } ], "operationId": "CreateFleet", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1396,6 +1899,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" + } + } } } } @@ -1413,6 +1931,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" + } } }, { @@ -1457,16 +1983,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1475,21 +2003,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" } }, "title": "ListFleetResponse" + }, + "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" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1501,10 +2111,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListFleet", - "x-maturity": [ - "Beta" - ] + "operationId": "ListFleet" } }, "/v1/Fleets/{Sid}": { @@ -1544,6 +2151,63 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1555,10 +2219,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.", @@ -1582,6 +2243,63 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1594,9 +2312,6 @@ } ], "operationId": "UpdateFleet", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1645,12 +2360,18 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -1680,6 +2401,78 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1692,9 +2485,6 @@ } ], "operationId": "CreateIpCommand", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1739,6 +2529,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 + } + } } } } @@ -1756,6 +2565,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" + } } }, { @@ -1773,6 +2590,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/ip_command_enum_status" + }, + "examples": { + "readEmpty": { + "value": "received" + }, + "readFull": { + "value": "received" + } } }, { @@ -1826,39 +2651,121 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" - }, - "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "type": "string" }, - "page": { + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListIpCommandResponse" + }, + "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" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1870,10 +2777,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListIpCommand", - "x-maturity": [ - "Beta" - ] + "operationId": "ListIpCommand" } }, "/v1/IpCommands/{Sid}": { @@ -1916,6 +2820,61 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1927,10 +2886,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchIpCommand", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchIpCommand" } }, "/v1/Networks/{Sid}": { @@ -1971,6 +2927,58 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1982,10 +2990,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchNetwork", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchNetwork" } }, "/v1/Networks": { @@ -2013,6 +3018,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" + } } }, { @@ -2021,6 +3031,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" + } } }, { @@ -2029,6 +3044,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" + } } }, { @@ -2073,16 +3093,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2091,21 +3113,111 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListNetworkResponse" + }, + "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" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2117,10 +3229,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListNetwork", - "x-maturity": [ - "Beta" - ] + "operationId": "ListNetwork" } }, "/v1/NetworkAccessProfiles": { @@ -2129,14 +3238,13 @@ "url": "https://supersim.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "fleets_count" ], - "pathType": "list", "dependentProperties": { "networks": { "mapping": { @@ -2144,7 +3252,8 @@ }, "resource_url": "/v1/NetworkAccessProfiles/{network_access_profile_sid}/Networks" } - } + }, + "pathType": "list" }, "post": { "description": "Create a new Network Access Profile", @@ -2157,6 +3266,70 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2169,9 +3342,6 @@ } ], "operationId": "CreateNetworkAccessProfile", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2191,12 +3361,23 @@ "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" + ] + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -2247,16 +3428,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2265,21 +3448,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" } }, "title": "ListNetworkAccessProfileResponse" + }, + "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" + } + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2291,10 +3550,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListNetworkAccessProfile", - "x-maturity": [ - "Beta" - ] + "operationId": "ListNetworkAccessProfile" } }, "/v1/NetworkAccessProfiles/{Sid}": { @@ -2303,14 +3559,13 @@ "url": "https://supersim.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "fleets_count" ], - "pathType": "instance", "dependentProperties": { "networks": { "mapping": { @@ -2318,7 +3573,8 @@ }, "resource_url": "/v1/NetworkAccessProfiles/{network_access_profile_sid}/Networks" } - } + }, + "pathType": "instance" }, "get": { "description": "Fetch a Network Access Profile instance from your account.", @@ -2342,6 +3598,57 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2353,10 +3660,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchNetworkAccessProfile", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchNetworkAccessProfile" }, "post": { "description": "Updates the given properties of a Network Access Profile in your account.", @@ -2380,6 +3684,57 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2392,9 +3747,6 @@ } ], "operationId": "UpdateNetworkAccessProfile", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2407,12 +3759,16 @@ "description": "The new unique name of the Network Access Profile." } } + }, + "examples": { + "updateUniqueName": { + "value": { + "UniqueName": "My Network Access Profile" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -2427,9 +3783,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.", @@ -2488,16 +3844,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2506,21 +3864,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" } }, "title": "ListNetworkAccessProfileNetworkResponse" + }, + "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" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2532,10 +3954,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListNetworkAccessProfileNetwork", - "x-maturity": [ - "Beta" - ] + "operationId": "ListNetworkAccessProfileNetwork" }, "post": { "description": "Add a Network resource to the Network Access Profile resource.", @@ -2559,6 +3978,59 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2571,9 +4043,6 @@ } ], "operationId": "CreateNetworkAccessProfileNetwork", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2592,6 +4061,13 @@ "required": [ "Network" ] + }, + "examples": { + "create": { + "value": { + "Network": "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -2609,9 +4085,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.", @@ -2654,10 +4130,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteNetworkAccessProfileNetwork", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteNetworkAccessProfileNetwork" }, "get": { "description": "Fetch a Network Access Profile resource's Network resource.", @@ -2693,10 +4166,63 @@ "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" + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" } }, "security": [ @@ -2704,10 +4230,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchNetworkAccessProfileNetwork", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchNetworkAccessProfileNetwork" } }, "/v1/SettingsUpdates": { @@ -2716,7 +4239,7 @@ "url": "https://supersim.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2738,6 +4261,14 @@ "description": "Filter the Settings Updates by a Super SIM's SID or UniqueName.", "schema": { "type": "string" + }, + "examples": { + "readSimOnly": { + "value": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readFull": { + "value": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -2747,6 +4278,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/settings_update_enum_status" + }, + "examples": { + "readStatusOnly": { + "value": "scheduled" + }, + "readFull": { + "value": "scheduled" + } } }, { @@ -2791,16 +4330,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2809,21 +4350,164 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListSettingsUpdateResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2835,10 +4519,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSettingsUpdate", - "x-maturity": [ - "Beta" - ] + "operationId": "ListSettingsUpdate" } }, "/v1/Sims": { @@ -2854,7 +4535,6 @@ "unique_name", "status" ], - "pathType": "list", "dependentProperties": { "billing_periods": { "mapping": { @@ -2868,7 +4548,8 @@ }, "resource_url": "/v1/Sims/{sim_sid}/IpAddresses" } - } + }, + "pathType": "list" }, "post": { "description": "Register a Super SIM to your Account", @@ -2881,6 +4562,61 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2893,9 +4629,6 @@ } ], "operationId": "CreateSim", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2916,6 +4649,14 @@ "Iccid", "RegistrationCode" ] + }, + "examples": { + "create": { + "value": { + "Iccid": "89883070000123456789", + "RegistrationCode": "H3LL0W0RLD" + } + } } } } @@ -2934,6 +4675,17 @@ "schema": { "type": "string", "$ref": "#/components/schemas/sim_enum_status" + }, + "examples": { + "readEmpty": { + "value": "new" + }, + "readFullByFleetSid": { + "value": "new" + }, + "readFullByFleetName": { + "value": "new" + } } }, { @@ -2942,6 +4694,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" + } } }, { @@ -2956,6 +4719,11 @@ "handling": "standard", "deleteSla": 30 } + }, + "examples": { + "readByIccid": { + "value": "89883070000123456789" + } } }, { @@ -3000,16 +4768,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "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,21 +4788,161 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListSimResponse" + }, + "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" + } + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3044,10 +4954,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSim", - "x-maturity": [ - "Beta" - ] + "operationId": "ListSim" } }, "/v1/Sims/{Sid}": { @@ -3063,7 +4970,6 @@ "unique_name", "status" ], - "pathType": "instance", "dependentProperties": { "billing_periods": { "mapping": { @@ -3077,7 +4983,8 @@ }, "resource_url": "/v1/Sims/{sim_sid}/IpAddresses" } - } + }, + "pathType": "instance" }, "get": { "description": "Fetch a Super SIM instance from your account.", @@ -3101,6 +5008,61 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3112,10 +5074,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSim", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchSim" }, "post": { "description": "Updates the given properties of a Super SIM instance from your account.", @@ -3139,6 +5098,112 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3149,6 +5214,61 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3161,9 +5281,6 @@ } ], "operationId": "UpdateSim", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3203,12 +5320,43 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -3224,9 +5372,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.", @@ -3285,16 +5433,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3303,21 +5453,90 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListSimIpAddressResponse" + }, + "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" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3329,10 +5548,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSimIpAddress", - "x-maturity": [ - "Beta" - ] + "operationId": "ListSimIpAddress" } }, "/v1/SmsCommands": { @@ -3361,6 +5577,70 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3373,9 +5653,6 @@ } ], "operationId": "CreateSmsCommand", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3410,6 +5687,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" + } + } } } } @@ -3427,6 +5720,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" + } } }, { @@ -3436,6 +5737,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/sms_command_enum_status" + }, + "examples": { + "readEmpty": { + "value": "received" + }, + "readFull": { + "value": "received" + } } }, { @@ -3489,16 +5798,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3507,21 +5818,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" } }, "title": "ListSmsCommandResponse" + }, + "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" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3533,10 +5920,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSmsCommand", - "x-maturity": [ - "Beta" - ] + "operationId": "ListSmsCommand" } }, "/v1/SmsCommands/{Sid}": { @@ -3579,6 +5963,57 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3590,10 +6025,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSmsCommand", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchSmsCommand" } }, "/v1/UsageRecords": { @@ -3622,6 +6054,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" + } } }, { @@ -3630,6 +6067,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" + } } }, { @@ -3641,6 +6083,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^HW[0-9a-fA-F]{32}$" + }, + "examples": { + "readDayNetworkFilter": { + "value": "HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -3650,6 +6097,14 @@ "schema": { "type": "string", "format": "iso-country-code" + }, + "examples": { + "readDayCountryFilter": { + "value": "FR" + }, + "readDayGroupBySimAndFilterByCountry": { + "value": "FR" + } } }, { @@ -3659,6 +6114,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" + } } }, { @@ -3668,6 +6140,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" + } } }, { @@ -3730,16 +6222,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3748,21 +6242,636 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListUsageRecordResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3774,10 +6883,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsageRecord", - "x-maturity": [ - "Beta" - ] + "operationId": "ListUsageRecord" } } }, @@ -3808,6 +6914,9 @@ { "name": "SupersimV1NetworkAccessProfileNetwork" }, + { + "name": "SupersimV1Ota" + }, { "name": "SupersimV1SettingsUpdate" }, @@ -3824,14 +6933,9 @@ "name": "SupersimV1UsageRecord" } ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - }, + "security": [ { - "name": "Beta", - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_sync_v1.json b/src/services/twilio-api/twilio_sync_v1.json index a670c4af..0af27203 100644 --- a/src/services/twilio-api/twilio_sync_v1.json +++ b/src/services/twilio-api/twilio_sync_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "sync.v1.service.document": { "type": "object", @@ -850,12 +856,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -871,7 +871,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -888,7 +888,6 @@ "unique_name", "revision" ], - "pathType": "instance", "dependentProperties": { "permissions": { "mapping": { @@ -898,7 +897,8 @@ "resource_url": "/v1/Services/{service_sid}/Documents/{document_sid}/Permissions" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -931,6 +931,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" + } + } + } } } }, @@ -939,6 +959,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -949,10 +1003,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDocument", - "x-maturity": [ - "GA" - ] + "operationId": "FetchDocument" }, "delete": { "description": "", @@ -989,10 +1040,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteDocument", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteDocument" }, "post": { "description": "", @@ -1033,6 +1081,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" + } + } + } } } }, @@ -1041,6 +1109,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -1052,9 +1154,6 @@ } ], "operationId": "UpdateDocument", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1070,12 +1169,18 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -1092,7 +1197,6 @@ "unique_name", "revision" ], - "pathType": "list", "dependentProperties": { "permissions": { "mapping": { @@ -1102,7 +1206,8 @@ "resource_url": "/v1/Services/{service_sid}/Documents/{document_sid}/Permissions" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -1126,6 +1231,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" + } + } + } } } }, @@ -1134,6 +1259,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "Created" @@ -1145,9 +1304,6 @@ } ], "operationId": "CreateDocument", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1167,12 +1323,18 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -1232,16 +1394,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1250,21 +1414,102 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListDocumentResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1276,10 +1521,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListDocument", - "x-maturity": [ - "GA" - ] + "operationId": "ListDocument" } }, "/v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}": { @@ -1296,9 +1538,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.", @@ -1346,6 +1588,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1357,10 +1649,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDocumentPermission", - "x-maturity": [ - "GA" - ] + "operationId": "FetchDocumentPermission" }, "delete": { "description": "Delete a specific Sync Document Permission.", @@ -1412,10 +1701,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteDocumentPermission", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteDocumentPermission" }, "post": { "description": "Update an identity's access to a specific Sync Document.", @@ -1463,6 +1749,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1475,9 +1811,6 @@ } ], "operationId": "UpdateDocumentPermission", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1503,6 +1836,15 @@ "Write", "Manage" ] + }, + "examples": { + "update": { + "value": { + "Read": "true", + "Write": "true", + "Manage": "true" + } + } } } } @@ -1523,9 +1865,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.", @@ -1593,16 +1935,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1611,21 +1955,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" } }, "title": "ListDocumentPermissionResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1637,10 +2056,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListDocumentPermission", - "x-maturity": [ - "GA" - ] + "operationId": "ListDocumentPermission" } }, "/v1/Services/{Sid}": { @@ -1656,7 +2072,6 @@ "unique_name", "friendly_name" ], - "pathType": "instance", "dependentProperties": { "documents": { "mapping": { @@ -1682,7 +2097,8 @@ }, "resource_url": "/v1/Services/{service_sid}/Streams" } - } + }, + "pathType": "instance" }, "get": { "description": "", @@ -1706,6 +2122,67 @@ "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1717,10 +2194,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchService", - "x-maturity": [ - "GA" - ] + "operationId": "FetchService" }, "delete": { "description": "", @@ -1748,10 +2222,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteService", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteService" }, "post": { "description": "", @@ -1775,6 +2246,67 @@ "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1787,9 +2319,6 @@ } ], "operationId": "UpdateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1827,12 +2356,18 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -1849,7 +2384,6 @@ "unique_name", "friendly_name" ], - "pathType": "list", "dependentProperties": { "documents": { "mapping": { @@ -1875,7 +2409,8 @@ }, "resource_url": "/v1/Services/{service_sid}/Streams" } - } + }, + "pathType": "list" }, "post": { "description": "", @@ -1888,6 +2423,67 @@ "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1900,9 +2496,6 @@ } ], "operationId": "CreateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1940,12 +2533,19 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -1996,16 +2596,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2014,21 +2616,107 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListServiceResponse" + }, + "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 + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2040,10 +2728,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListService", - "x-maturity": [ - "GA" - ] + "operationId": "ListService" } }, "/v1/Services/{ServiceSid}/Streams/{StreamSid}/Messages": { @@ -2052,14 +2737,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.", @@ -2092,6 +2777,50 @@ "application/json": { "schema": { "$ref": "#/components/schemas/sync.v1.service.sync_stream.stream_message" + }, + "examples": { + "create": { + "value": { + "sid": "TZaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "data": {} + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2104,9 +2833,6 @@ } ], "operationId": "CreateStreamMessage", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2121,6 +2847,13 @@ "required": [ "Data" ] + }, + "examples": { + "create": { + "value": { + "Data": "{}" + } + } } } } @@ -2140,7 +2873,6 @@ "unique_name", "revision" ], - "pathType": "instance", "dependentProperties": { "items": { "mapping": { @@ -2158,7 +2890,8 @@ } }, "parent": "/Services/{Sid}", - "mountName": "sync_lists" + "mountName": "sync_lists", + "pathType": "instance" }, "get": { "description": "", @@ -2191,6 +2924,62 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2202,10 +2991,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncList", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSyncList" }, "delete": { "description": "", @@ -2242,10 +3028,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncList", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSyncList" }, "post": { "description": "", @@ -2278,6 +3061,62 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2290,9 +3129,6 @@ } ], "operationId": "UpdateSyncList", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2309,12 +3145,16 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -2331,7 +3171,6 @@ "unique_name", "revision" ], - "pathType": "list", "dependentProperties": { "items": { "mapping": { @@ -2349,7 +3188,8 @@ } }, "parent": "/Services/{Sid}", - "mountName": "sync_lists" + "mountName": "sync_lists", + "pathType": "list" }, "post": { "description": "", @@ -2373,6 +3213,62 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2385,9 +3281,6 @@ } ], "operationId": "CreateSyncList", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2408,12 +3301,17 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -2473,16 +3371,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "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,21 +3391,102 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListSyncListResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2517,10 +3498,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncList", - "x-maturity": [ - "GA" - ] + "operationId": "ListSyncList" } }, "/v1/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}": { @@ -2536,9 +3514,9 @@ "revision", "created_by" ], - "pathType": "instance", "parent": "/Services/{ServiceSid}/Lists/{Sid}", - "mountName": "sync_list_items" + "mountName": "sync_list_items", + "pathType": "instance" }, "get": { "description": "", @@ -2580,6 +3558,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" + } + } } } }, @@ -2588,6 +3583,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -2598,10 +3627,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncListItem", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSyncListItem" }, "delete": { "description": "", @@ -2655,10 +3681,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncListItem", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSyncListItem" }, "post": { "description": "", @@ -2708,6 +3731,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" + } + } } } }, @@ -2716,6 +3756,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -2727,9 +3801,6 @@ } ], "operationId": "UpdateSyncListItem", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2753,12 +3824,17 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -2775,9 +3851,9 @@ "revision", "created_by" ], - "pathType": "list", "parent": "/Services/{ServiceSid}/Lists/{Sid}", - "mountName": "sync_list_items" + "mountName": "sync_list_items", + "pathType": "list" }, "post": { "description": "", @@ -2810,6 +3886,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" + } + } } } }, @@ -2818,6 +3911,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "Created" @@ -2829,9 +3956,6 @@ } ], "operationId": "CreateSyncListItem", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2858,6 +3982,14 @@ "required": [ "Data" ] + }, + "examples": { + "create": { + "value": { + "Data": "{}", + "Ttl": 3600 + } + } } } } @@ -2894,6 +4026,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/sync_list_item_enum_query_result_order" + }, + "examples": { + "readEmpty": { + "value": "asc" + }, + "readFull": { + "value": "asc" + } } }, { @@ -2902,6 +4042,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" + } } }, { @@ -2911,6 +4059,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/sync_list_item_enum_query_from_bound_type" + }, + "examples": { + "readEmpty": { + "value": "inclusive" + }, + "readFull": { + "value": "inclusive" + } } }, { @@ -2955,16 +4111,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2973,41 +4131,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" } }, "title": "ListSyncListItemResponse" + }, + "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": [ - { + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListSyncListItem" + } + }, + "/v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}": { + "servers": [ + { "url": "https://sync.twilio.com" } ], @@ -3019,9 +4252,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.", @@ -3069,6 +4302,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3080,10 +4363,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncListPermission", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSyncListPermission" }, "delete": { "description": "Delete a specific Sync List Permission.", @@ -3135,10 +4415,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncListPermission", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSyncListPermission" }, "post": { "description": "Update an identity's access to a specific Sync List.", @@ -3186,6 +4463,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3198,9 +4525,6 @@ } ], "operationId": "UpdateSyncListPermission", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3226,6 +4550,15 @@ "Write", "Manage" ] + }, + "examples": { + "update": { + "value": { + "Read": "true", + "Write": "true", + "Manage": "true" + } + } } } } @@ -3246,9 +4579,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.", @@ -3316,16 +4649,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3334,21 +4669,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" } }, "title": "ListSyncListPermissionResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3360,10 +4770,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncListPermission", - "x-maturity": [ - "GA" - ] + "operationId": "ListSyncListPermission" } }, "/v1/Services/{ServiceSid}/Maps/{Sid}": { @@ -3379,7 +4786,6 @@ "unique_name", "revision" ], - "pathType": "instance", "dependentProperties": { "items": { "mapping": { @@ -3397,7 +4803,8 @@ } }, "parent": "/Services/{Sid}", - "mountName": "sync_maps" + "mountName": "sync_maps", + "pathType": "instance" }, "get": { "description": "", @@ -3430,6 +4837,62 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3441,10 +4904,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncMap", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSyncMap" }, "delete": { "description": "", @@ -3481,10 +4941,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncMap", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSyncMap" }, "post": { "description": "", @@ -3517,6 +4974,62 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3529,9 +5042,6 @@ } ], "operationId": "UpdateSyncMap", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3548,12 +5058,16 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -3570,7 +5084,6 @@ "unique_name", "revision" ], - "pathType": "list", "dependentProperties": { "items": { "mapping": { @@ -3588,7 +5101,8 @@ } }, "parent": "/Services/{Sid}", - "mountName": "sync_maps" + "mountName": "sync_maps", + "pathType": "list" }, "post": { "description": "", @@ -3612,6 +5126,62 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3624,9 +5194,6 @@ } ], "operationId": "CreateSyncMap", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3647,12 +5214,17 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -3712,16 +5284,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3730,21 +5304,102 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListSyncMapResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3756,10 +5411,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncMap", - "x-maturity": [ - "GA" - ] + "operationId": "ListSyncMap" } }, "/v1/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}": { @@ -3775,9 +5427,9 @@ "revision", "created_by" ], - "pathType": "instance", "parent": "/Services/{ServiceSid}/Maps/{Sid}", - "mountName": "sync_map_items" + "mountName": "sync_map_items", + "pathType": "instance" }, "get": { "description": "", @@ -3825,6 +5477,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" + } + } } } }, @@ -3833,6 +5502,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -3843,10 +5546,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncMapItem", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSyncMapItem" }, "delete": { "description": "", @@ -3906,10 +5606,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncMapItem", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSyncMapItem" }, "post": { "description": "", @@ -3965,6 +5662,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" + } + } } } }, @@ -3973,6 +5687,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -3984,9 +5732,6 @@ } ], "operationId": "UpdateSyncMapItem", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4010,12 +5755,17 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -4032,9 +5782,9 @@ "revision", "created_by" ], - "pathType": "list", "parent": "/Services/{ServiceSid}/Maps/{Sid}", - "mountName": "sync_map_items" + "mountName": "sync_map_items", + "pathType": "list" }, "post": { "description": "", @@ -4067,6 +5817,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" + } + } } } }, @@ -4075,6 +5842,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "Created" @@ -4086,9 +5887,6 @@ } ], "operationId": "CreateSyncMapItem", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4120,6 +5918,15 @@ "Key", "Data" ] + }, + "examples": { + "create": { + "value": { + "Data": "{}", + "Key": "key", + "Ttl": 3600 + } + } } } } @@ -4156,6 +5963,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/sync_map_item_enum_query_result_order" + }, + "examples": { + "readEmpty": { + "value": "asc" + }, + "readFull": { + "value": "asc" + } } }, { @@ -4164,6 +5979,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" + } } }, { @@ -4173,6 +5996,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/sync_map_item_enum_query_from_bound_type" + }, + "examples": { + "readEmpty": { + "value": "inclusive" + }, + "readFull": { + "value": "inclusive" + } } }, { @@ -4217,16 +6048,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4235,21 +6068,99 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListSyncMapItemResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4261,10 +6172,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncMapItem", - "x-maturity": [ - "GA" - ] + "operationId": "ListSyncMapItem" } }, "/v1/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}": { @@ -4273,7 +6181,7 @@ "url": "https://sync.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "identity", @@ -4281,9 +6189,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.", @@ -4331,6 +6239,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4342,10 +6300,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncMapPermission", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSyncMapPermission" }, "delete": { "description": "Delete a specific Sync Map Permission.", @@ -4397,10 +6352,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncMapPermission", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSyncMapPermission" }, "post": { "description": "Update an identity's access to a specific Sync Map.", @@ -4448,6 +6400,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4460,9 +6462,6 @@ } ], "operationId": "UpdateSyncMapPermission", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4488,6 +6487,15 @@ "Write", "Manage" ] + }, + "examples": { + "update": { + "value": { + "Read": "true", + "Write": "true", + "Manage": "true" + } + } } } } @@ -4500,7 +6508,7 @@ "url": "https://sync.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "identity", @@ -4508,9 +6516,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.", @@ -4578,16 +6586,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4596,21 +6606,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" } }, "title": "ListSyncMapPermissionResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4622,10 +6707,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncMapPermission", - "x-maturity": [ - "GA" - ] + "operationId": "ListSyncMapPermission" } }, "/v1/Services/{ServiceSid}/Streams/{Sid}": { @@ -4634,14 +6716,13 @@ "url": "https://sync.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "created_by" ], - "pathType": "instance", "dependentProperties": { "messages": { "mapping": { @@ -4652,7 +6733,8 @@ } }, "parent": "/Services/{Sid}", - "mountName": "sync_streams" + "mountName": "sync_streams", + "pathType": "instance" }, "get": { "description": "Fetch a specific Stream.", @@ -4685,6 +6767,60 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4696,10 +6832,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncStream", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSyncStream" }, "delete": { "description": "Delete a specific Stream.", @@ -4736,10 +6869,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncStream", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSyncStream" }, "post": { "description": "Update a specific Stream.", @@ -4772,6 +6902,60 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4784,9 +6968,6 @@ } ], "operationId": "UpdateSyncStream", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4799,12 +6980,16 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -4814,14 +6999,13 @@ "url": "https://sync.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "created_by" ], - "pathType": "list", "dependentProperties": { "messages": { "mapping": { @@ -4832,7 +7016,8 @@ } }, "parent": "/Services/{Sid}", - "mountName": "sync_streams" + "mountName": "sync_streams", + "pathType": "list" }, "post": { "description": "Create a new Stream.", @@ -4856,6 +7041,60 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4868,9 +7107,6 @@ } ], "operationId": "CreateSyncStream", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4887,12 +7123,17 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -4952,16 +7193,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4970,21 +7213,100 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListSyncStreamResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4996,10 +7318,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncStream", - "x-maturity": [ - "GA" - ] + "operationId": "ListSyncStream" } } }, @@ -5043,10 +7362,9 @@ "name": "SyncV1SyncStream" } ], - "x-maturity": [ + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_taskrouter_v1.json b/src/services/twilio-api/twilio_taskrouter_v1.json index 390614be..c75ae125 100644 --- a/src/services/twilio-api/twilio_taskrouter_v1.json +++ b/src/services/twilio-api/twilio_taskrouter_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "taskrouter.v1.workspace.activity": { "type": "object", @@ -2106,12 +2112,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -2127,7 +2127,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -2137,15 +2137,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": "", @@ -2184,6 +2184,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" + } + } + } } } }, @@ -2202,6 +2219,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -2212,10 +2263,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchActivity", - "x-maturity": [ - "GA" - ] + "operationId": "FetchActivity" }, "post": { "description": "", @@ -2254,6 +2302,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" + } + } + } } } }, @@ -2272,6 +2337,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -2283,9 +2382,6 @@ } ], "operationId": "UpdateActivity", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2298,12 +2394,16 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -2364,10 +2464,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteActivity", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteActivity" } }, "/v1/Workspaces/{WorkspaceSid}/Activities": { @@ -2376,15 +2473,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": "", @@ -2410,6 +2507,14 @@ "description": "The `friendly_name` of the Activity resources to read.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -2418,6 +2523,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" + } } }, { @@ -2462,16 +2575,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2480,21 +2595,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" } }, "title": "ListActivityResponse" + }, + "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" + } + } + } } } }, @@ -2513,6 +2670,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -2523,10 +2714,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListActivity", - "x-maturity": [ - "GA" - ] + "operationId": "ListActivity" }, "post": { "description": "", @@ -2553,6 +2741,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" + } + } + } } } }, @@ -2571,6 +2776,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "Created" @@ -2582,9 +2821,6 @@ } ], "operationId": "CreateActivity", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2604,6 +2840,14 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "Available": "true", + "FriendlyName": "friendly_name" + } + } } } } @@ -2616,15 +2860,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": "", @@ -2663,6 +2907,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" + } + } } } }, @@ -2681,6 +2958,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -2691,10 +3002,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEvent", - "x-maturity": [ - "GA" - ] + "operationId": "FetchEvent" } }, "/v1/Workspaces/{WorkspaceSid}/Events": { @@ -2703,15 +3011,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": "", @@ -2738,6 +3046,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFull": { + "value": "2008-01-03T00:00:00Z" + }, + "readEmpty": { + "value": "2008-01-03T00:00:00Z" + } } }, { @@ -2746,6 +3062,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" + } } }, { @@ -2765,6 +3089,14 @@ "minLength": 34, "maxLength": 34, "pattern": "^WR[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -2774,6 +3106,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFull": { + "value": "2008-01-02T00:00:00Z" + }, + "readEmpty": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -2785,6 +3125,14 @@ "minLength": 34, "maxLength": 34, "pattern": "^WQ[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -2796,6 +3144,14 @@ "minLength": 34, "maxLength": 34, "pattern": "^WT[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -2807,6 +3163,14 @@ "minLength": 34, "maxLength": 34, "pattern": "^WK[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -2818,6 +3182,14 @@ "minLength": 34, "maxLength": 34, "pattern": "^WW[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -2881,16 +3253,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2899,21 +3273,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" } }, "title": "ListEventResponse" + }, + "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" + } + } + } } } }, @@ -2932,6 +3364,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -2942,10 +3408,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListEvent", - "x-maturity": [ - "GA" - ] + "operationId": "ListEvent" } }, "/v1/Workspaces/{WorkspaceSid}/Tasks/{Sid}": { @@ -2954,7 +3417,7 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2963,7 +3426,6 @@ "priority", "reason" ], - "pathType": "instance", "dependentProperties": { "reservations": { "mapping": { @@ -2973,7 +3435,8 @@ "resource_url": "/v1/Workspaces/{workspace_sid}/Tasks/{task_sid}/Reservations" } }, - "parent": "/Workspaces/{Sid}" + "parent": "/Workspaces/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -3012,6 +3475,41 @@ "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", + "virtual_start_time": "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", + "ignore_capacity": false, + "routing_target": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "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" + } + } + } } } }, @@ -3035,6 +3533,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -3045,10 +3577,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTask", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTask" }, "post": { "description": "", @@ -3095,6 +3624,41 @@ "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", + "virtual_start_time": "2023-08-02T12:34:56Z", + "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": "{}", + "ignore_capacity": false, + "routing_target": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "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" + } + } + } } } }, @@ -3118,20 +3682,51 @@ "schema": { "type": "string" } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateTask", - "x-maturity": [ - "GA" + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } ], + "operationId": "UpdateTask", "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3166,12 +3761,20 @@ "description": "The task's new virtual start time value. When supplied, the Task takes on the specified virtual start time. Value can't be in the future." } } + }, + "examples": { + "update": { + "value": { + "AssignmentStatus": "pending", + "Attributes": "attributes", + "Priority": 1, + "Reason": "reason", + "VirtualStartTime": "2023-08-02T12:34:56Z" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -3240,10 +3843,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteTask", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteTask" } }, "/v1/Workspaces/{WorkspaceSid}/Tasks": { @@ -3252,7 +3852,7 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3261,7 +3861,6 @@ "priority", "reason" ], - "pathType": "list", "dependentProperties": { "reservations": { "mapping": { @@ -3271,7 +3870,8 @@ "resource_url": "/v1/Workspaces/{workspace_sid}/Tasks/{task_sid}/Reservations" } }, - "parent": "/Workspaces/{Sid}" + "parent": "/Workspaces/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -3297,6 +3897,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 + } } }, { @@ -3308,6 +3919,20 @@ "items": { "type": "string" } + }, + "examples": { + "readFull": { + "value": "pending,reserved" + }, + "readEmpty": { + "value": "pending" + }, + "readAssignmentStatusMultiple": { + "value": [ + "pending", + "reserved" + ] + } } }, { @@ -3319,6 +3944,17 @@ "minLength": 34, "maxLength": 34, "pattern": "^WW[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readAssignmentStatusMultiple": { + "value": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -3327,6 +3963,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" + } } }, { @@ -3338,6 +3985,17 @@ "minLength": 34, "maxLength": 34, "pattern": "^WQ[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readAssignmentStatusMultiple": { + "value": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -3346,6 +4004,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" + } } }, { @@ -3362,6 +4031,17 @@ "description": "A SID of a Worker, Queue, or Workflow to route a Task to", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readAssignmentStatusMultiple": { + "value": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -3422,16 +4102,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3440,21 +4122,95 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListTaskResponse" + }, + "examples": { + "readFull": { + "value": { + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&RoutingTarget=WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&TaskQueueName=task_queue_name&WorkflowName=workflow_name&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AssignmentStatus=pending%2Creserved&Priority=1&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&RoutingTarget=WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&TaskQueueName=task_queue_name&WorkflowName=workflow_name&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AssignmentStatus=pending%2Creserved&Priority=1&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", + "virtual_start_time": "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", + "ignore_capacity": false, + "routing_target": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "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&RoutingTarget=WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&TaskQueueName=task_queue_name&WorkflowName=workflow_name&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AssignmentStatus=pending&Priority=1&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&RoutingTarget=WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&TaskQueueName=task_queue_name&WorkflowName=workflow_name&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AssignmentStatus=pending&Priority=1&PageSize=50&Page=0" + }, + "tasks": [] + } + }, + "readAssignmentStatusMultiple": { + "value": { + "meta": { + "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&RoutingTarget=WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&TaskQueueName=task_queue_name&WorkflowName=workflow_name&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AssignmentStatus=pending&Priority=1&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&RoutingTarget=WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&TaskQueueName=task_queue_name&WorkflowName=workflow_name&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AssignmentStatus=pending&Priority=1&PageSize=50&Page=0" + }, + "tasks": [] + } + } } } }, @@ -3478,6 +4234,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -3488,10 +4278,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTask", - "x-maturity": [ - "GA" - ] + "operationId": "ListTask" }, "post": { "description": "", @@ -3518,6 +4305,41 @@ "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, + "virtual_start_time": "2014-05-14T18:50:02Z", + "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", + "ignore_capacity": false, + "routing_target": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "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" + } + } + } } } }, @@ -3541,6 +4363,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "Created" @@ -3552,9 +4408,6 @@ } ], "operationId": "CreateTask", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3606,12 +4459,24 @@ "description": "The SID of the TaskQueue in which the Task belongs" } } + }, + "examples": { + "create": { + "value": { + "Attributes": "{\"body\": \"attributes\"}", + "Priority": 1, + "Timeout": 1, + "WorkflowSid": "WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "TaskChannel": "channel", + "VirtualStartTime": "2014-05-14T18:50:02Z", + "IgnoreCapacity": "false", + "RoutingTarget": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "TaskQueueSid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -3628,8 +4493,8 @@ "friendly_name", "date_created" ], - "pathType": "instance", - "parent": "/Workspaces/{Sid}" + "parent": "/Workspaces/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -3665,6 +4530,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" + } + } + } } } }, @@ -3683,6 +4582,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -3693,10 +4626,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTaskChannel", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTaskChannel" }, "post": { "description": "", @@ -3732,6 +4662,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" + } + } + } } } }, @@ -3750,6 +4714,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -3761,9 +4759,6 @@ } ], "operationId": "UpdateTaskChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3780,12 +4775,23 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -3843,10 +4849,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteTaskChannel", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteTaskChannel" } }, "/v1/Workspaces/{WorkspaceSid}/TaskChannels": { @@ -3862,8 +4865,8 @@ "friendly_name", "date_created" ], - "pathType": "list", - "parent": "/Workspaces/{Sid}" + "parent": "/Workspaces/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -3925,16 +4928,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3943,21 +4948,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" } }, "title": "ListTaskChannelResponse" + }, + "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" + } + } + } } } }, @@ -3976,6 +5024,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -3986,10 +5068,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTaskChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListTaskChannel" }, "post": { "description": "", @@ -4016,6 +5095,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" + } + } + } } } }, @@ -4034,6 +5131,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "Created" @@ -4045,9 +5176,6 @@ } ], "operationId": "CreateTaskChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4072,6 +5200,14 @@ "FriendlyName", "UniqueName" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "Outbound Voice", + "UniqueName": "ovoice" + } + } } } } @@ -4084,14 +5220,13 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "task_order" ], - "pathType": "instance", "dependentProperties": { "statistics": { "mapping": { @@ -4115,7 +5250,8 @@ "resource_url": "/v1/Workspaces/{workspace_sid}/TaskQueues/{task_queue_sid}/CumulativeStatistics" } }, - "parent": "/Workspaces/{Sid}" + "parent": "/Workspaces/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -4154,6 +5290,37 @@ "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", + "bulk_real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/RealTimeStatistics" + }, + "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" + } + } } } }, @@ -4172,6 +5339,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -4182,10 +5383,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTaskQueue", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTaskQueue" }, "post": { "description": "", @@ -4224,6 +5422,37 @@ "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", + "bulk_real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/RealTimeStatistics" + }, + "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" + } + } } } }, @@ -4242,6 +5471,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -4253,9 +5516,6 @@ } ], "operationId": "UpdateTaskQueue", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4295,12 +5555,21 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -4361,10 +5630,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteTaskQueue", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteTaskQueue" } }, "/v1/Workspaces/{WorkspaceSid}/TaskQueues": { @@ -4373,14 +5639,13 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "task_order" ], - "pathType": "list", "dependentProperties": { "statistics": { "mapping": { @@ -4404,7 +5669,8 @@ "resource_url": "/v1/Workspaces/{workspace_sid}/TaskQueues/{task_queue_sid}/CumulativeStatistics" } }, - "parent": "/Workspaces/{Sid}" + "parent": "/Workspaces/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -4436,6 +5702,14 @@ "handling": "standard", "deleteSla": 30 } + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -4444,6 +5718,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" + } } }, { @@ -4507,16 +5789,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4525,21 +5809,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" } }, "title": "ListTaskQueueResponse" + }, + "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", + "bulk_real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/RealTimeStatistics" + }, + "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": [] + } + } } } }, @@ -4558,6 +5898,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -4568,10 +5942,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTaskQueue", - "x-maturity": [ - "GA" - ] + "operationId": "ListTaskQueue" }, "post": { "description": "", @@ -4598,6 +5969,37 @@ "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", + "bulk_real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/RealTimeStatistics" + }, + "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" + } + } } } }, @@ -4616,6 +6018,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "Created" @@ -4627,9 +6063,6 @@ } ], "operationId": "CreateTaskQueue", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4672,6 +6105,18 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "AssignmentActivitySid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name", + "MaxReservedWorkers": 1, + "ReservationActivitySid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "TargetWorkers": "target_workers", + "OperatingUnitSid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -4684,7 +6129,7 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "account_sid", @@ -4692,10 +6137,159 @@ "task_queue_data", "task_queue_response_count" ], - "pathType": "list", "parent": "/Workspaces/{WorkspaceSid}/TaskQueues", "mountName": "bulk_real_time_statistics", - "className": "task_queue_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.", + "tags": [ + "TaskrouterV1TaskQueueBulkRealTimeStatistics" + ], + "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": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/taskrouter.v1.workspace.task_queue.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": [ + { + "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 + } + } + } + } + }, + "headers": { + "X-Rate-Limit-Limit": { + "schema": { + "type": "string" + } + }, + "X-Rate-Limit-Remaining": { + "schema": { + "type": "string" + } + }, + "X-Rate-Limit-Config": { + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateTaskQueueBulkRealTimeStatistics", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "CreateTaskQueueBulkRealTimeStatisticsRequest", + "properties": {} + } + } + } + } } }, "/v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/CumulativeStatistics": { @@ -4704,7 +6298,7 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "start_time", @@ -4712,9 +6306,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": "", @@ -4753,6 +6347,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2015-07-30T20:00:00Z" + } } }, { @@ -4770,6 +6369,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2015-07-30T20:00:00Z" + } } }, { @@ -4795,6 +6399,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 + } + } } } }, @@ -4813,6 +6481,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -4823,10 +6525,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTaskQueueCumulativeStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTaskQueueCumulativeStatistics" } }, "/v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/RealTimeStatistics": { @@ -4835,16 +6534,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": "", @@ -4882,6 +6581,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" + } } } ], @@ -4891,6 +6595,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" + } + } } } }, @@ -4898,16 +6648,50 @@ "X-Rate-Limit-Limit": { "schema": { "type": "string" - } + } + }, + "X-Rate-Limit-Remaining": { + "schema": { + "type": "string" + } + }, + "X-Rate-Limit-Config": { + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" }, - "X-Rate-Limit-Remaining": { + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", "schema": { - "type": "string" + "type": "boolean" } }, - "X-Rate-Limit-Config": { + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", "schema": { - "type": "string" + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4919,10 +6703,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTaskQueueRealTimeStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTaskQueueRealTimeStatistics" } }, "/v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/Statistics": { @@ -4931,14 +6712,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": "", @@ -4977,6 +6758,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -4985,6 +6771,11 @@ "description": "Only calculate statistics since this many minutes in the past. The default is 15 minutes.", "schema": { "type": "integer" + }, + "examples": { + "fetch": { + "value": 1 + } } }, { @@ -4994,6 +6785,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -5019,6 +6815,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" + } + } } } }, @@ -5037,6 +6903,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -5047,10 +6947,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTaskQueueStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTaskQueueStatistics" } }, "/v1/Workspaces/{WorkspaceSid}/TaskQueues/Statistics": { @@ -5059,14 +6956,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": "", @@ -5093,6 +6990,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFull": { + "value": "2008-01-02T00:00:00Z" + }, + "readEmpty": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -5101,6 +7006,14 @@ "description": "The `friendly_name` of the TaskQueue statistics to read.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -5109,6 +7022,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 + } } }, { @@ -5118,6 +7039,14 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFull": { + "value": "2008-01-02T00:00:00Z" + }, + "readEmpty": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -5178,16 +7107,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5196,21 +7127,115 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListTaskQueuesStatisticsResponse" + }, + "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": [] + } + } } } }, @@ -5229,6 +7254,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -5239,10 +7298,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTaskQueuesStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "ListTaskQueuesStatistics" } }, "/v1/Workspaces/{WorkspaceSid}/Tasks/{TaskSid}/Reservations": { @@ -5259,8 +7315,8 @@ "worker_name", "worker_sid" ], - "pathType": "list", - "parent": "/Workspaces/{WorkspaceSid}/Tasks/{Sid}" + "parent": "/Workspaces/{WorkspaceSid}/Tasks/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -5354,16 +7410,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5372,21 +7430,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" } }, "title": "ListTaskReservationResponse" + }, + "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": [] + } + } } } }, @@ -5410,6 +7514,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -5420,10 +7558,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTaskReservation", - "x-maturity": [ - "GA" - ] + "operationId": "ListTaskReservation" } }, "/v1/Workspaces/{WorkspaceSid}/Tasks/{TaskSid}/Reservations/{Sid}": { @@ -5440,8 +7575,8 @@ "worker_name", "worker_sid" ], - "pathType": "instance", - "parent": "/Workspaces/{WorkspaceSid}/Tasks/{Sid}" + "parent": "/Workspaces/{WorkspaceSid}/Tasks/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -5492,6 +7627,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" + } + } } } }, @@ -5515,6 +7671,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -5525,10 +7715,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTaskReservation", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTaskReservation" }, "post": { "description": "", @@ -5587,6 +7774,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" + } + } } } }, @@ -5610,6 +7837,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -5621,9 +7882,6 @@ } ], "operationId": "UpdateTaskReservation", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5907,12 +8165,23 @@ "description": "The jitter buffer size for conference. Can be: `small`, `medium`, `large`, `off`." } } + }, + "examples": { + "update": { + "value": { + "ReservationStatus": "accepted" + } + }, + "updateSuperviseInstruction": { + "value": { + "Instruction": "supervise", + "SupervisorMode": "monitor", + "Supervisor": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -5922,14 +8191,13 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "available" ], - "pathType": "list", "dependentProperties": { "real_time_statistics": { "mapping": { @@ -5965,7 +8233,8 @@ "resource_url": "/v1/Workspaces/{workspace_sid}/Workers/{worker_sid}/Channels" } }, - "parent": "/Workspaces/{Sid}" + "parent": "/Workspaces/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -5991,6 +8260,14 @@ "description": "The `activity_name` of the Worker resources to read.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "activity_name" + }, + "readEmpty": { + "value": "activity_name" + } } }, { @@ -6002,6 +8279,14 @@ "minLength": 34, "maxLength": 34, "pattern": "^WA[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -6010,6 +8295,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" + } } }, { @@ -6024,6 +8317,14 @@ "handling": "standard", "deleteSla": 30 } + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -6032,6 +8333,14 @@ "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" + } } }, { @@ -6040,6 +8349,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" + } } }, { @@ -6051,6 +8368,14 @@ "minLength": 34, "maxLength": 34, "pattern": "^WQ[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "readEmpty": { + "value": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -6103,16 +8428,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -6121,21 +8448,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" } }, "title": "ListWorkerResponse" + }, + "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": [] + } + } } } }, @@ -6159,6 +8541,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -6169,10 +8585,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListWorker", - "x-maturity": [ - "GA" - ] + "operationId": "ListWorker" }, "post": { "description": "", @@ -6199,6 +8612,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" + } + } + } } } }, @@ -6213,14 +8656,48 @@ "type": "string" } }, - "X-Rate-Limit-Remaining": { + "X-Rate-Limit-Remaining": { + "schema": { + "type": "string" + } + }, + "X-Rate-Limit-Config": { + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", "schema": { - "type": "string" + "type": "boolean" } }, - "X-Rate-Limit-Config": { + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", "schema": { - "type": "string" + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6233,9 +8710,6 @@ } ], "operationId": "CreateWorker", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6262,6 +8736,16 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "ActivitySid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Attributes": "attributes", + "FriendlyName": "friendly_name", + "OperatingUnitSid": "OUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -6274,14 +8758,13 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "available" ], - "pathType": "instance", "dependentProperties": { "real_time_statistics": { "mapping": { @@ -6317,7 +8800,8 @@ "resource_url": "/v1/Workspaces/{workspace_sid}/Workers/{worker_sid}/Channels" } }, - "parent": "/Workspaces/{Sid}" + "parent": "/Workspaces/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -6356,6 +8840,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" + } + } + } } } }, @@ -6379,6 +8893,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -6389,10 +8937,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorker", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorker" }, "post": { "description": "", @@ -6439,6 +8984,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" + } + } + } } } }, @@ -6462,6 +9037,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -6473,9 +9082,6 @@ } ], "operationId": "UpdateWorker", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6503,12 +9109,19 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -6577,10 +9190,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteWorker", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteWorker" } }, "/v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Channels": { @@ -6589,16 +9199,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": "", @@ -6672,16 +9282,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -6690,21 +9302,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" } }, "title": "ListWorkerChannelResponse" + }, + "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": [] + } + } } } }, @@ -6723,6 +9379,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -6733,10 +9423,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListWorkerChannel", - "x-maturity": [ - "GA" - ] + "operationId": "ListWorkerChannel" } }, "/v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Channels/{Sid}": { @@ -6745,16 +9432,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": "", @@ -6802,6 +9489,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" + } + } } } }, @@ -6820,6 +9526,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -6830,10 +9570,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkerChannel", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkerChannel" }, "post": { "description": "", @@ -6881,6 +9618,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" + } + } } } }, @@ -6899,6 +9655,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -6910,9 +9700,6 @@ } ], "operationId": "UpdateWorkerChannel", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6929,12 +9716,16 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -6944,14 +9735,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": "", @@ -6989,6 +9780,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 + } } }, { @@ -6998,6 +9794,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -7007,6 +9808,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -7024,6 +9830,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" + } + } } } }, @@ -7042,6 +9902,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -7052,10 +9946,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkerInstanceStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkerInstanceStatistics" } }, "/v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations": { @@ -7071,8 +9962,8 @@ "reservation_status", "date_created" ], - "pathType": "list", - "parent": "/Workspaces/{WorkspaceSid}/Workers/{Sid}" + "parent": "/Workspaces/{WorkspaceSid}/Workers/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -7155,16 +10046,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -7173,21 +10066,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" } }, "title": "ListWorkerReservationResponse" + }, + "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": [] + } + } } } }, @@ -7211,6 +10150,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -7221,10 +10194,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListWorkerReservation", - "x-maturity": [ - "GA" - ] + "operationId": "ListWorkerReservation" } }, "/v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations/{Sid}": { @@ -7240,8 +10210,8 @@ "reservation_status", "date_created" ], - "pathType": "instance", - "parent": "/Workspaces/{WorkspaceSid}/Workers/{Sid}" + "parent": "/Workspaces/{WorkspaceSid}/Workers/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -7292,6 +10262,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" + } + } } } }, @@ -7310,6 +10301,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -7320,10 +10345,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkerReservation", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkerReservation" }, "post": { "description": "", @@ -7382,6 +10404,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" + } + } } } }, @@ -7389,16 +10432,50 @@ "X-Rate-Limit-Limit": { "schema": { "type": "string" - } + } + }, + "X-Rate-Limit-Remaining": { + "schema": { + "type": "string" + } + }, + "X-Rate-Limit-Config": { + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" }, - "X-Rate-Limit-Remaining": { + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", "schema": { - "type": "string" + "type": "boolean" } }, - "X-Rate-Limit-Config": { + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", "schema": { - "type": "string" + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -7411,9 +10488,6 @@ } ], "operationId": "UpdateWorkerReservation", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -7688,12 +10762,16 @@ "description": "The jitter buffer size for conference. Can be: `small`, `medium`, `large`, `off`." } } + }, + "examples": { + "update": { + "value": { + "ReservationStatus": "accepted" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -7703,14 +10781,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": "", @@ -7736,6 +10814,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 + } } }, { @@ -7745,6 +10828,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -7754,6 +10842,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -7798,6 +10891,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" + } + } } } }, @@ -7816,6 +10987,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -7826,10 +11031,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkerStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkerStatistics" } }, "/v1/Workspaces/{WorkspaceSid}/Workers/CumulativeStatistics": { @@ -7838,7 +11040,7 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "reservations_created", @@ -7848,9 +11050,9 @@ "reservations_canceled", "reservations_rescinded" ], - "pathType": "instance", "parent": "/Workspaces/{WorkspaceSid}/Workers/{Sid}", - "className": "workers_cumulative_statistics" + "className": "workers_cumulative_statistics", + "pathType": "instance" }, "get": { "description": "", @@ -7877,6 +11079,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2015-07-30T20:00:00Z" + } } }, { @@ -7894,6 +11101,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2015-07-30T20:00:00Z" + } } }, { @@ -7911,6 +11123,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" + } + } } } }, @@ -7929,6 +11192,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -7939,10 +11236,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkersCumulativeStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkersCumulativeStatistics" } }, "/v1/Workspaces/{WorkspaceSid}/Workers/RealTimeStatistics": { @@ -7951,14 +11245,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": "", @@ -7984,6 +11278,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" + } } } ], @@ -7993,6 +11292,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" + } + ] + } + } } } }, @@ -8011,6 +11342,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -8021,10 +11386,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkersRealTimeStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkersRealTimeStatistics" } }, "/v1/Workspaces/{WorkspaceSid}/Workflows/{Sid}": { @@ -8033,14 +11395,13 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "document_content_type" ], - "pathType": "instance", "dependentProperties": { "statistics": { "mapping": { @@ -8064,7 +11425,8 @@ "resource_url": "/v1/Workspaces/{workspace_sid}/Workflows/{workflow_sid}/CumulativeStatistics" } }, - "parent": "/Workspaces/{Sid}" + "parent": "/Workspaces/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -8103,6 +11465,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" + } + } + } } } }, @@ -8121,6 +11506,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -8131,10 +11550,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkflow", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkflow" }, "post": { "description": "", @@ -8173,6 +11589,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" + } + } } } }, @@ -8191,6 +11630,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -8202,9 +11675,6 @@ } ], "operationId": "UpdateWorkflow", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -8239,12 +11709,21 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -8305,10 +11784,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteWorkflow", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteWorkflow" } }, "/v1/Workspaces/{WorkspaceSid}/Workflows": { @@ -8317,14 +11793,13 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "document_content_type" ], - "pathType": "list", "dependentProperties": { "statistics": { "mapping": { @@ -8348,7 +11823,8 @@ "resource_url": "/v1/Workspaces/{workspace_sid}/Workflows/{workflow_sid}/CumulativeStatistics" } }, - "parent": "/Workspaces/{Sid}" + "parent": "/Workspaces/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -8380,6 +11856,14 @@ "handling": "standard", "deleteSla": 30 } + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -8424,16 +11908,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -8442,21 +11928,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" } }, "title": "ListWorkflowResponse" + }, + "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": [] + } + } } } }, @@ -8475,6 +12009,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -8485,10 +12053,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListWorkflow", - "x-maturity": [ - "GA" - ] + "operationId": "ListWorkflow" }, "post": { "description": "", @@ -8515,6 +12080,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" + } + } + } } } }, @@ -8533,6 +12121,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "Created" @@ -8544,9 +12166,6 @@ } ], "operationId": "CreateWorkflow", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -8581,6 +12200,17 @@ "FriendlyName", "Configuration" ] + }, + "examples": { + "create": { + "value": { + "AssignmentCallbackUrl": "http://example.com", + "Configuration": "configuration", + "FallbackAssignmentCallbackUrl": "http://example.com", + "FriendlyName": "friendly_name", + "TaskReservationTimeout": 1 + } + } } } } @@ -8593,7 +12223,7 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "start_time", @@ -8601,9 +12231,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": "", @@ -8642,6 +12272,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2015-07-30T20:00:00Z" + } } }, { @@ -8659,6 +12294,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2015-07-30T20:00:00Z" + } } }, { @@ -8684,6 +12324,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 + } + } } } }, @@ -8702,6 +12401,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -8712,10 +12445,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkflowCumulativeStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkflowCumulativeStatistics" } }, "/v1/Workspaces/{WorkspaceSid}/Workflows/{WorkflowSid}/RealTimeStatistics": { @@ -8724,16 +12454,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": "", @@ -8771,6 +12501,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" + } } } ], @@ -8780,6 +12515,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" + } + } } } }, @@ -8789,14 +12544,48 @@ "type": "string" } }, - "X-Rate-Limit-Remaining": { + "X-Rate-Limit-Remaining": { + "schema": { + "type": "string" + } + }, + "X-Rate-Limit-Config": { + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" - } + }, + "example": "*" }, - "X-Rate-Limit-Config": { + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -8808,10 +12597,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkflowRealTimeStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkflowRealTimeStatistics" } }, "/v1/Workspaces/{WorkspaceSid}/Workflows/{WorkflowSid}/Statistics": { @@ -8820,14 +12606,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": "", @@ -8865,6 +12651,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 + } } }, { @@ -8874,6 +12665,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -8883,6 +12679,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -8908,6 +12709,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" + } + } } } }, @@ -8926,6 +12760,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -8936,10 +12804,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkflowStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkflowStatistics" } }, "/v1/Workspaces/{Sid}": { @@ -8948,14 +12813,13 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "prioritize_queue_order" ], - "pathType": "instance", "dependentProperties": { "activities": { "mapping": { @@ -9017,7 +12881,8 @@ }, "resource_url": "/v1/Workspaces/{workspace_sid}/TaskChannels" } - } + }, + "pathType": "instance" }, "get": { "description": "", @@ -9044,6 +12909,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" + } + } } } }, @@ -9062,6 +12960,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -9072,10 +13004,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkspace", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkspace" }, "post": { "description": "", @@ -9102,6 +13031,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" + } + } } } }, @@ -9120,6 +13082,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -9131,9 +13127,6 @@ } ], "operationId": "UpdateWorkspace", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -9178,12 +13171,19 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -9232,10 +13232,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteWorkspace", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteWorkspace" } }, "/v1/Workspaces": { @@ -9244,14 +13241,13 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "prioritize_queue_order" ], - "pathType": "list", "dependentProperties": { "activities": { "mapping": { @@ -9313,7 +13309,8 @@ }, "resource_url": "/v1/Workspaces/{workspace_sid}/TaskChannels" } - } + }, + "pathType": "list" }, "get": { "description": "", @@ -9333,6 +13330,14 @@ "handling": "standard", "deleteSla": 30 } + }, + "examples": { + "readFull": { + "value": "friendly_name" + }, + "readEmpty": { + "value": "friendly_name" + } } }, { @@ -9377,16 +13382,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -9395,21 +13402,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" } }, "title": "ListWorkspaceResponse" + }, + "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": [] + } + } } } }, @@ -9428,6 +13493,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -9438,10 +13537,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListWorkspace", - "x-maturity": [ - "GA" - ] + "operationId": "ListWorkspace" }, "post": { "description": "", @@ -9454,6 +13550,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" + } + } } } }, @@ -9472,6 +13601,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "Created" @@ -9483,9 +13646,6 @@ } ], "operationId": "CreateWorkspace", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -9523,6 +13683,15 @@ "required": [ "FriendlyName" ] + }, + "examples": { + "create": { + "value": { + "EventCallbackUrl": "/example", + "FriendlyName": "friendly_name", + "Template": "template" + } + } } } } @@ -9535,7 +13704,7 @@ "url": "https://taskrouter.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "start_time", @@ -9543,9 +13712,9 @@ "avg_task_acceptance_time", "tasks_completed" ], - "pathType": "instance", "parent": "/Workspaces/{Sid}", - "className": "workspace_cumulative_statistics" + "className": "workspace_cumulative_statistics", + "pathType": "instance" }, "get": { "description": "", @@ -9572,6 +13741,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2015-07-30T20:00:00Z" + } } }, { @@ -9589,6 +13763,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2015-07-30T20:00:00Z" + } } }, { @@ -9614,6 +13793,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" + } + } } } }, @@ -9632,6 +13869,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -9642,10 +13913,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkspaceCumulativeStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkspaceCumulativeStatistics" } }, "/v1/Workspaces/{WorkspaceSid}/RealTimeStatistics": { @@ -9654,16 +13922,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": "", @@ -9689,6 +13957,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" + } } } ], @@ -9698,6 +13971,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": {} + } + } } } }, @@ -9716,6 +14026,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -9726,10 +14070,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkspaceRealTimeStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkspaceRealTimeStatistics" } }, "/v1/Workspaces/{WorkspaceSid}/Statistics": { @@ -9738,14 +14079,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": "", @@ -9771,6 +14112,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 + } } }, { @@ -9780,6 +14126,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -9789,6 +14140,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2008-01-02T00:00:00Z" + } } }, { @@ -9814,6 +14170,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" + } + } } } }, @@ -9832,6 +14257,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -9842,10 +14301,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWorkspaceStatistics", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWorkspaceStatistics" } } }, @@ -9858,9 +14314,18 @@ { "name": "TaskrouterV1Activity" }, + { + "name": "TaskrouterV1AttentionProfile" + }, + { + "name": "TaskrouterV1AttentionProfileChannel" + }, { "name": "TaskrouterV1Event" }, + { + "name": "TaskrouterV1OperatingUnit" + }, { "name": "TaskrouterV1Reservation" }, @@ -9873,6 +14338,9 @@ { "name": "TaskrouterV1TaskQueue" }, + { + "name": "TaskrouterV1TaskQueueBulkRealTimeStatistics" + }, { "name": "TaskrouterV1TaskQueueCumulativeStatistics" }, @@ -9928,10 +14396,9 @@ "name": "TaskrouterV1WorkspaceStatistics" } ], - "x-maturity": [ + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_trunking_v1.json b/src/services/twilio-api/twilio_trunking_v1.json index 88ee9103..a0d15c80 100644 --- a/src/services/twilio-api/twilio_trunking_v1.json +++ b/src/services/twilio-api/twilio_trunking_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "trunking.v1.trunk.credential_list": { "type": "object", @@ -551,12 +557,6 @@ "from-transferor" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -572,7 +572,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -589,10 +589,10 @@ "friendly_name", "date_created" ], - "pathType": "instance", "parent": "/Trunks/{Sid}", "mountName": "credentials_lists", - "className": "credential_list" + "className": "credential_list", + "pathType": "instance" }, "get": { "description": "", @@ -631,6 +631,55 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -642,10 +691,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCredentialList", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCredentialList" }, "delete": { "description": "", @@ -688,10 +734,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCredentialList", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCredentialList" } }, "/v1/Trunks/{TrunkSid}/CredentialLists": { @@ -707,10 +750,10 @@ "friendly_name", "date_created" ], - "pathType": "list", "parent": "/Trunks/{Sid}", "mountName": "credentials_lists", - "className": "credential_list" + "className": "credential_list", + "pathType": "list" }, "post": { "description": "", @@ -737,6 +780,55 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -749,9 +841,6 @@ } ], "operationId": "CreateCredentialList", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -770,6 +859,13 @@ "required": [ "CredentialListSid" ] + }, + "examples": { + "create": { + "value": { + "CredentialListSid": "CLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -835,16 +931,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -853,21 +951,95 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListCredentialListResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -879,10 +1051,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCredentialList", - "x-maturity": [ - "GA" - ] + "operationId": "ListCredentialList" } }, "/v1/Trunks/{TrunkSid}/IpAccessControlLists/{Sid}": { @@ -898,8 +1067,8 @@ "friendly_name", "date_created" ], - "pathType": "instance", - "parent": "/Trunks/{Sid}" + "parent": "/Trunks/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -938,6 +1107,55 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -949,10 +1167,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchIpAccessControlList", - "x-maturity": [ - "GA" - ] + "operationId": "FetchIpAccessControlList" }, "delete": { "description": "Remove an associated IP Access Control List from a Trunk", @@ -995,10 +1210,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteIpAccessControlList", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteIpAccessControlList" } }, "/v1/Trunks/{TrunkSid}/IpAccessControlLists": { @@ -1014,8 +1226,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", @@ -1042,6 +1254,55 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1054,9 +1315,6 @@ } ], "operationId": "CreateIpAccessControlList", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1075,6 +1333,13 @@ "required": [ "IpAccessControlListSid" ] + }, + "examples": { + "create": { + "value": { + "IpAccessControlListSid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -1140,16 +1405,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1158,21 +1425,95 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListIpAccessControlListResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1184,10 +1525,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListIpAccessControlList", - "x-maturity": [ - "GA" - ] + "operationId": "ListIpAccessControlList" } }, "/v1/Trunks/{TrunkSid}/OriginationUrls/{Sid}": { @@ -1205,8 +1543,8 @@ "priority", "weight" ], - "pathType": "instance", - "parent": "/Trunks/{Sid}" + "parent": "/Trunks/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -1245,6 +1583,59 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1256,10 +1647,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchOriginationUrl", - "x-maturity": [ - "GA" - ] + "operationId": "FetchOriginationUrl" }, "delete": { "description": "", @@ -1302,10 +1690,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteOriginationUrl", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteOriginationUrl" }, "post": { "description": "", @@ -1344,6 +1729,59 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1356,9 +1794,6 @@ } ], "operationId": "UpdateOriginationUrl", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1388,12 +1823,20 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -1412,8 +1855,8 @@ "priority", "weight" ], - "pathType": "list", - "parent": "/Trunks/{Sid}" + "parent": "/Trunks/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -1440,6 +1883,59 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1452,9 +1948,6 @@ } ], "operationId": "CreateOriginationUrl", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1491,6 +1984,17 @@ "FriendlyName", "SipUrl" ] + }, + "examples": { + "create": { + "value": { + "Enabled": true, + "FriendlyName": "friendly_name", + "Priority": 1, + "Weight": 1, + "SipUrl": "sip://sip-box.com:1234" + } + } } } } @@ -1556,16 +2060,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1574,21 +2080,99 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListOriginationUrlResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1600,10 +2184,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListOriginationUrl", - "x-maturity": [ - "GA" - ] + "operationId": "ListOriginationUrl" } }, "/v1/Trunks/{TrunkSid}/PhoneNumbers/{Sid}": { @@ -1619,8 +2200,8 @@ "friendly_name", "phone_number" ], - "pathType": "instance", - "parent": "/Trunks/{Sid}" + "parent": "/Trunks/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -1659,6 +2240,80 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1670,10 +2325,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchPhoneNumber", - "x-maturity": [ - "GA" - ] + "operationId": "FetchPhoneNumber" }, "delete": { "description": "", @@ -1716,10 +2368,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeletePhoneNumber", - "x-maturity": [ - "GA" - ] + "operationId": "DeletePhoneNumber" } }, "/v1/Trunks/{TrunkSid}/PhoneNumbers": { @@ -1735,8 +2384,8 @@ "friendly_name", "phone_number" ], - "pathType": "list", - "parent": "/Trunks/{Sid}" + "parent": "/Trunks/{Sid}", + "pathType": "list" }, "post": { "description": "", @@ -1763,6 +2412,80 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1775,9 +2498,6 @@ } ], "operationId": "CreatePhoneNumber", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1796,6 +2516,13 @@ "required": [ "PhoneNumberSid" ] + }, + "examples": { + "create": { + "value": { + "PhoneNumberSid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -1861,16 +2588,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1879,21 +2608,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" } }, "title": "ListPhoneNumberResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1905,10 +2733,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListPhoneNumber", - "x-maturity": [ - "GA" - ] + "operationId": "ListPhoneNumber" } }, "/v1/Trunks/{TrunkSid}/Recording": { @@ -1923,9 +2748,9 @@ "mode", "trim" ], - "pathType": "instance", "parent": "/Trunks/{Sid}", - "mountName": "recordings" + "mountName": "recordings", + "pathType": "instance" }, "get": { "description": "", @@ -1952,6 +2777,50 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trunking.v1.trunk.recording" + }, + "examples": { + "fetch": { + "value": { + "mode": "do-not-record", + "trim": "do-not-trim" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1963,10 +2832,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRecording", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRecording" }, "post": { "description": "", @@ -1993,6 +2859,50 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trunking.v1.trunk.recording" + }, + "examples": { + "update": { + "value": { + "mode": "do-not-record", + "trim": "do-not-trim" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2005,9 +2915,6 @@ } ], "operationId": "UpdateRecording", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2026,12 +2933,17 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -2048,7 +2960,6 @@ "friendly_name", "domain_name" ], - "pathType": "instance", "dependentProperties": { "origination_urls": { "mapping": { @@ -2080,7 +2991,8 @@ }, "resource_url": "/v1/Trunks/{trunk_sid}/Recording" } - } + }, + "pathType": "instance" }, "get": { "description": "", @@ -2107,6 +3019,73 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2118,10 +3097,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTrunk", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTrunk" }, "delete": { "description": "", @@ -2152,10 +3128,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteTrunk", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteTrunk" }, "post": { "description": "", @@ -2182,6 +3155,73 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2194,9 +3234,6 @@ } ], "operationId": "UpdateTrunk", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2245,12 +3282,22 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -2267,7 +3314,6 @@ "friendly_name", "domain_name" ], - "pathType": "list", "dependentProperties": { "origination_urls": { "mapping": { @@ -2299,7 +3345,8 @@ }, "resource_url": "/v1/Trunks/{trunk_sid}/Recording" } - } + }, + "pathType": "list" }, "post": { "description": "", @@ -2312,6 +3359,73 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2324,9 +3438,6 @@ } ], "operationId": "CreateTrunk", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2375,12 +3486,23 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -2431,16 +3553,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2449,21 +3573,113 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListTrunkResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2475,10 +3691,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTrunk", - "x-maturity": [ - "GA" - ] + "operationId": "ListTrunk" } } }, @@ -2507,10 +3720,9 @@ "name": "TrunkingV1Trunk" } ], - "x-maturity": [ + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_trusthub_v1.json b/src/services/twilio-api/twilio_trusthub_v1.json index 7c46141d..f8e2ad5c 100644 --- a/src/services/twilio-api/twilio_trusthub_v1.json +++ b/src/services/twilio-api/twilio_trusthub_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "trusthub.v1.compliance_inquiry": { "type": "object", @@ -923,12 +929,6 @@ "noncompliant" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -944,7 +944,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -954,16 +954,16 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "inquiry_id", "session_token", "customer_id" ], - "pathType": "list", "mountName": "compliance_inquiries", - "className": "compliance_inquiries" + "className": "compliance_inquiries", + "pathType": "list" }, "post": { "description": "Create a new Compliance Inquiry for the authenticated account. This is necessary to start a new embedded session.", @@ -976,6 +976,60 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.compliance_inquiry" + }, + "examples": { + "create": { + "value": { + "inquiry_id": "inq_aaaaaaaaaaaaaaaaaaaaaaaa", + "inquiry_session_token": "new.session.token", + "customer_id": "tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trusthub.twilio.com/v1/ComplianceInquiries/Customers/tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Initialize" + } + }, + "createWithNotificationEmail": { + "value": { + "inquiry_id": "inq_aaaaaaaaaaaaaaaaaaaaaaaa", + "inquiry_session_token": "new.session.token", + "customer_id": "tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trusthub.twilio.com/v1/ComplianceInquiries/Customers/tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Initialize" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -988,9 +1042,6 @@ } ], "operationId": "CreateComplianceInquiry", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1013,6 +1064,19 @@ "required": [ "PrimaryProfileSid" ] + }, + "examples": { + "create": { + "value": { + "PrimaryProfileSid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createWithNotificationEmail": { + "value": { + "PrimaryProfileSid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "NotificationEmail": "pfarnsworth@twilio.com" + } + } } } } @@ -1025,16 +1089,16 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "inquiry_id", "session_token", "customer_id" ], - "pathType": "instance", "mountName": "compliance_inquiries", - "className": "compliance_inquiries" + "className": "compliance_inquiries", + "pathType": "instance" }, "post": { "description": "Resume a specific Compliance Inquiry that has expired, or re-open a rejected Compliance Inquiry for editing.", @@ -1058,6 +1122,52 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.compliance_inquiry" + }, + "examples": { + "update": { + "value": { + "inquiry_id": "inq_aaaaaaaaaaaaaaaaaaaaaaaa", + "inquiry_session_token": "new.session.token", + "customer_id": "tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trusthub.twilio.com/v1/ComplianceInquiries/Customers/tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Initialize" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1070,9 +1180,6 @@ } ], "operationId": "UpdateComplianceInquiry", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1091,6 +1198,13 @@ "required": [ "PrimaryProfileSid" ] + }, + "examples": { + "update": { + "value": { + "PrimaryProfileSid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -1103,16 +1217,16 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "inquiry_id", "session_token", "registration_id" ], - "pathType": "list", "mountName": "compliance_registration_inquiries", - "className": "compliance_registration_inquiries" + "className": "compliance_registration_inquiries", + "pathType": "list" }, "post": { "description": "Create a new Compliance Registration Inquiry for the authenticated account. This is necessary to start a new embedded session.", @@ -1125,6 +1239,52 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.compliance_registration" + }, + "examples": { + "create": { + "value": { + "inquiry_id": "inq_aaaaaaaaaaaaaaaaaaaaaaaa", + "inquiry_session_token": "new.session.token", + "registration_id": "tri1.us1.account.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.registartion.PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trusthub.twilio.com/v1/ComplianceInquiries/Registration/tri1.us1.account.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.registartion.PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RegulatoryCompliance/GB/Initialize" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1137,9 +1297,6 @@ } ], "operationId": "CreateComplianceRegistration", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1312,6 +1469,51 @@ "EndUserType", "PhoneNumberType" ] + }, + "examples": { + "create": { + "value": { + "EndUserType": "Individual", + "FirstName": "firstname", + "LastName": "lastname", + "DateOfBirth": "1990-01-01", + "IndividualEmail": "test@test.com", + "IndividualPhone": "123456", + "PhoneNumberType": "national", + "BusinessLegalName": "Owl, Inc.", + "NotificationEmail": "test@test.com", + "AcceptedNotificationReceipt": true, + "BusinessRegistrationNumber": "123456789", + "BusinessWebsiteUrl": "https://twilio.co", + "FriendlyName": "Owl", + "AuthorizedRepresentative1FirstName": "firstname", + "AuthorizedRepresentative1LastName": "lastname", + "AuthorizedRepresentative1Email": "test@test.com", + "AuthorizedRepresentative1DateOfBirth": "1990-01-01", + "AuthorizedRepresentative1Phone": "+9199992222222", + "AddressStreet": "123 Main St", + "AddressStreetSecondary": "Apt 1", + "AddressCity": "San Francisco", + "AddressSubdivision": "CA", + "AddressPostalCode": "94107", + "AddressCountryCode": "US", + "UseAddressAsEmergencyAddress": true, + "EmergencyAddressStreet": "123 Main St", + "EmergencyAddressStreetSecondary": "Apt 1", + "EmergencyAddressCity": "San Francisco", + "EmergencyAddressSubdivision": "CA", + "EmergencyAddressPostalCode": "94107", + "EmergencyAddressCountryCode": "US", + "FileName": "fileName", + "File": "file", + "BusinessIdentityType": "direct_customer", + "BusinessRegistrationAuthority": "UK:CRN", + "IsIsvEmbed": true, + "IsvRegisteringForSelfOrTenant": "my_customer", + "StatusCallbackUrl": "https://status.com", + "ThemeSetId": "th_xxxxx" + } + } } } } @@ -1324,16 +1526,16 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "inquiry_id", "session_token", "registration_id" ], - "pathType": "instance", "mountName": "compliance_registration_inquiries", - "className": "compliance_registration_inquiries" + "className": "compliance_registration_inquiries", + "pathType": "instance" }, "post": { "description": "Resume a specific Regulatory Compliance Inquiry that has expired, or re-open a rejected Compliance Inquiry for editing.", @@ -1357,6 +1559,52 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.compliance_registration" + }, + "examples": { + "update": { + "value": { + "inquiry_id": "inq_aaaaaaaaaaaaaaaaaaaaaaaa", + "inquiry_session_token": "new.session.token", + "registration_id": "tri1.us1.account.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.registration.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trusthub.twilio.com/v1/ComplianceInquiries/Registration/tri1.us1.account.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.registration.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RegulatoryCompliance/GB/Initialize" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1369,9 +1617,6 @@ } ], "operationId": "UpdateComplianceRegistration", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1388,12 +1633,17 @@ "description": "Theme id for styling the inquiry form." } } + }, + "examples": { + "update": { + "value": { + "ThemeSetId": "th_xxxxx", + "IsIsvEmbed": true + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -1403,16 +1653,16 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "inquiry_id", "session_token", "registration_id" ], - "pathType": "list", "mountName": "compliance_tollfree_inquiries", - "className": "compliance_tollfree_inquiries" + "className": "compliance_tollfree_inquiries", + "pathType": "list" }, "post": { "description": "Create a new Compliance Tollfree Verification Inquiry for the authenticated account. This is necessary to start a new embedded session.", @@ -1425,6 +1675,60 @@ "application/json": { "schema": { "$ref": "#/components/schemas/trusthub.v1.compliance_tollfree_inquiry" + }, + "examples": { + "create": { + "value": { + "inquiry_id": "inq_aaaaaaaaaaaaaaaaaaaaaaaa", + "inquiry_session_token": "new.session.token", + "registration_id": "tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.tollfree.PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trusthub.twilio.com/v1/ComplianceInquiries/Tollfree/Initialize" + } + }, + "create2": { + "value": { + "inquiry_id": "inq_aaaaaaaaaaaaaaaaaaaaaaaa", + "inquiry_session_token": "new.session.token", + "registration_id": "tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.tollfree.PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trusthub.twilio.com/v1/ComplianceInquiries/Tollfree/Initialize" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1437,9 +1741,6 @@ } ], "operationId": "CreateComplianceTollfreeInquiry", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1543,12 +1844,57 @@ "ThemeSetId": { "type": "string", "description": "Theme id for styling the inquiry form." + }, + "SkipMessagingUseCase": { + "type": "boolean", + "description": "Skip the messaging use case screen of the inquiry form." } }, "required": [ "TollfreePhoneNumber", "NotificationEmail" ] + }, + "examples": { + "create": { + "value": { + "TollfreePhoneNumber": "+123445566", + "NotificationEmail": "jeff@twilio.com" + } + }, + "create2": { + "value": { + "TollfreePhoneNumber": "+123445566", + "NotificationEmail": "jeff@twilio.com", + "BusinessName": "Owl, Inc.", + "BusinessStreetAddress": "123 Main Street", + "BusinessStreetAddress2": "Suite 101", + "BusinessCity": "Anytown", + "BusinessStateProvinceRegion": "AA", + "BusinessPostalCode": "11111", + "BusinessCountry": "US", + "BusinessWebsite": "http://www.company.com", + "BusinessContactFirstName": "firstname", + "BusinessContactLastName": "lastname", + "BusinessContactEmail": "email@company.com", + "BusinessContactPhone": "+1231231234", + "UseCaseCategories": [ + "TWO_FACTOR_AUTHENTICATION", + "MARKETING" + ], + "UseCaseSummary": "This number is used to send out promotional offers and coupons to the customers of John's Coffee Shop", + "ProductionMessageSample": "lorem ipsum", + "OptInImageUrls": [ + "https://testbusiness.com/images/image1.jpg", + "https://testbusiness.com/images/image2.jpg" + ], + "OptInType": "VERBAL", + "MessageVolume": "10", + "AdditionalInformation": "see our privacy policy here www.johnscoffeeshop.com/privacypolicy", + "ThemeSetId": "theme_set_id", + "SkipMessagingUseCase": true + } + } } } } @@ -1561,14 +1907,13 @@ "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": { "mapping": { @@ -1589,7 +1934,8 @@ "resource_url": "/v1/CustomerProfiles/{customer_profile_sid}/ChannelEndpointAssignments" } }, - "className": "customer_profiles" + "className": "customer_profiles", + "pathType": "list" }, "post": { "description": "Create a new Customer-Profile.", @@ -1602,6 +1948,65 @@ "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" + }, + "errors": null + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1614,9 +2019,6 @@ } ], "operationId": "CreateCustomerProfile", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1650,6 +2052,16 @@ "Email", "PolicySid" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "Email": "email", + "PolicySid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "StatusCallback": "http://www.example.com" + } + } } } } @@ -1668,6 +2080,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/customer_profile_enum_status" + }, + "examples": { + "readFull": { + "value": "draft" + } } }, { @@ -1676,6 +2093,11 @@ "description": "The string that you assigned to describe the resource.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "friendly_name" + } } }, { @@ -1687,6 +2109,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^RN[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -1731,16 +2158,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1749,21 +2178,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" } }, "title": "ListCustomerProfileResponse" + }, + "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": "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", + "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" + }, + "errors": [ + { + "code": 18601 + } + ] + } + ], + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1775,10 +2292,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCustomerProfile", - "x-maturity": [ - "GA" - ] + "operationId": "ListCustomerProfile" } }, "/v1/CustomerProfiles/{Sid}": { @@ -1787,14 +2301,13 @@ "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": { "mapping": { @@ -1815,7 +2328,8 @@ "resource_url": "/v1/CustomerProfiles/{customer_profile_sid}/ChannelEndpointAssignments" } }, - "className": "customer_profiles" + "className": "customer_profiles", + "pathType": "instance" }, "get": { "description": "Fetch a specific Customer-Profile instance.", @@ -1842,6 +2356,69 @@ "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" + }, + "errors": [ + { + "code": 18601 + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1853,10 +2430,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCustomerProfile", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCustomerProfile" }, "post": { "description": "Updates a Customer-Profile in an account.", @@ -1883,6 +2457,86 @@ "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" + }, + "errors": null + } + }, + "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" + }, + "errors": null + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1895,9 +2549,6 @@ } ], "operationId": "UpdateCustomerProfile", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1924,12 +2575,24 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -1961,10 +2624,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCustomerProfile", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCustomerProfile" } }, "/v1/CustomerProfiles/{CustomerProfileSid}/ChannelEndpointAssignments": { @@ -1973,14 +2633,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.", @@ -2007,6 +2667,55 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2019,9 +2728,6 @@ } ], "operationId": "CreateCustomerProfileChannelEndpointAssignment", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2045,6 +2751,14 @@ "ChannelEndpointType", "ChannelEndpointSid" ] + }, + "examples": { + "create": { + "value": { + "ChannelEndpointSid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ChannelEndpointType": "phone-number" + } + } } } } @@ -2077,6 +2791,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -2129,16 +2848,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2147,36 +2868,107 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListCustomerProfileChannelEndpointAssignmentResponse" + }, + "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" - } - }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, "security": [ { "accountSid_authToken": [] } ], - "operationId": "ListCustomerProfileChannelEndpointAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "ListCustomerProfileChannelEndpointAssignment" } }, "/v1/CustomerProfiles/{CustomerProfileSid}/ChannelEndpointAssignments/{Sid}": { @@ -2185,14 +2977,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.", @@ -2231,6 +3023,55 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2242,10 +3083,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCustomerProfileChannelEndpointAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCustomerProfileChannelEndpointAssignment" }, "delete": { "description": "Remove an Assignment Item Instance.", @@ -2288,10 +3126,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCustomerProfileChannelEndpointAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCustomerProfileChannelEndpointAssignment" } }, "/v1/CustomerProfiles/{CustomerProfileSid}/EntityAssignments": { @@ -2300,15 +3135,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.", @@ -2335,6 +3170,54 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2347,9 +3230,6 @@ } ], "operationId": "CreateCustomerProfileEntityAssignment", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2368,6 +3248,13 @@ "required": [ "ObjectSid" ] + }, + "examples": { + "create": { + "value": { + "ObjectSid": "ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -2441,16 +3328,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2459,21 +3348,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" } }, "title": "ListCustomerProfileEntityAssignmentResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2485,10 +3447,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCustomerProfileEntityAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "ListCustomerProfileEntityAssignment" } }, "/v1/CustomerProfiles/{CustomerProfileSid}/EntityAssignments/{Sid}": { @@ -2497,15 +3456,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.", @@ -2544,6 +3503,54 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2555,10 +3562,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCustomerProfileEntityAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCustomerProfileEntityAssignment" }, "delete": { "description": "Remove an Assignment Item Instance.", @@ -2601,10 +3605,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCustomerProfileEntityAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCustomerProfileEntityAssignment" } }, "/v1/CustomerProfiles/{CustomerProfileSid}/Evaluations": { @@ -2613,15 +3614,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", @@ -2648,6 +3649,362 @@ "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" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2660,9 +4017,6 @@ } ], "operationId": "CreateCustomerProfileEvaluation", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2681,6 +4035,23 @@ "required": [ "PolicySid" ] + }, + "examples": { + "create": { + "value": { + "PolicySid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createCompliantStarterCustomerProfile": { + "value": { + "PolicySid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createCompliantSoleProprietorA2PProfile": { + "value": { + "PolicySid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -2746,16 +4117,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2764,21 +4137,246 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListCustomerProfileEvaluationResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2790,10 +4388,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCustomerProfileEvaluation", - "x-maturity": [ - "GA" - ] + "operationId": "ListCustomerProfileEvaluation" } }, "/v1/CustomerProfiles/{CustomerProfileSid}/Evaluations/{Sid}": { @@ -2802,15 +4397,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.", @@ -2849,6 +4444,206 @@ "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" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2860,10 +4655,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCustomerProfileEvaluation", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCustomerProfileEvaluation" } }, "/v1/EndUsers": { @@ -2872,7 +4664,7 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -2891,6 +4683,63 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2903,9 +4752,6 @@ } ], "operationId": "CreateEndUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2929,6 +4775,15 @@ "FriendlyName", "Type" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "auth_rep_1", + "Type": "authorized_representative_1", + "Attributes": "{}" + } + } } } } @@ -2982,16 +4837,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3000,21 +4857,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" } }, "title": "ListEndUserResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3026,10 +4965,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListEndUser", - "x-maturity": [ - "GA" - ] + "operationId": "ListEndUser" } }, "/v1/EndUsers/{Sid}": { @@ -3038,7 +4974,7 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3071,21 +5007,75 @@ "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": [ - { + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { "accountSid_authToken": [] } ], - "operationId": "FetchEndUser", - "x-maturity": [ - "GA" - ] + "operationId": "FetchEndUser" }, "post": { "description": "Update an existing End User.", @@ -3112,6 +5102,63 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3124,9 +5171,6 @@ } ], "operationId": "UpdateEndUser", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3142,12 +5186,17 @@ "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": "{}" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -3179,10 +5228,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteEndUser", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteEndUser" } }, "/v1/EndUserTypes": { @@ -3191,7 +5237,7 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3247,16 +5293,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3265,21 +5313,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" } }, "title": "ListEndUserTypeResponse" + }, + "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" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3291,10 +5442,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListEndUserType", - "x-maturity": [ - "GA" - ] + "operationId": "ListEndUserType" } }, "/v1/EndUserTypes/{Sid}": { @@ -3303,7 +5451,7 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3333,6 +5481,84 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3344,10 +5570,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEndUserType", - "x-maturity": [ - "GA" - ] + "operationId": "FetchEndUserType" } }, "/v1/Policies": { @@ -3356,14 +5579,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.", @@ -3413,16 +5636,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3431,21 +5656,162 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListPoliciesResponse" + }, + "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" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3457,10 +5823,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListPolicies", - "x-maturity": [ - "GA" - ] + "operationId": "ListPolicies" } }, "/v1/Policies/{Sid}": { @@ -3469,14 +5832,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.", @@ -3503,6 +5866,219 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3514,10 +6090,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchPolicies", - "x-maturity": [ - "GA" - ] + "operationId": "FetchPolicies" } }, "/v1/SupportingDocuments": { @@ -3526,7 +6099,7 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3545,6 +6118,60 @@ "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3557,9 +6184,6 @@ } ], "operationId": "CreateSupportingDocument", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3583,6 +6207,15 @@ "FriendlyName", "Type" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "Business-profile-physical-address", + "Type": "customer_profile_address", + "Attributes": "{}" + } + } } } } @@ -3636,16 +6269,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3654,21 +6289,100 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListSupportingDocumentResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3680,10 +6394,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSupportingDocument", - "x-maturity": [ - "GA" - ] + "operationId": "ListSupportingDocument" } }, "/v1/SupportingDocuments/{Sid}": { @@ -3692,7 +6403,7 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3725,6 +6436,60 @@ "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3736,10 +6501,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSupportingDocument", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSupportingDocument" }, "post": { "description": "Update an existing Supporting Document.", @@ -3766,6 +6528,60 @@ "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3778,9 +6594,6 @@ } ], "operationId": "UpdateSupportingDocument", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3796,12 +6609,17 @@ "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": "{}" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -3833,10 +6651,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSupportingDocument", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSupportingDocument" } }, "/v1/SupportingDocumentTypes": { @@ -3845,7 +6660,7 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3901,16 +6716,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3919,21 +6736,122 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListSupportingDocumentTypeResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3945,10 +6863,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSupportingDocumentType", - "x-maturity": [ - "GA" - ] + "operationId": "ListSupportingDocumentType" } }, "/v1/SupportingDocumentTypes/{Sid}": { @@ -3957,7 +6872,7 @@ "url": "https://trusthub.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3987,6 +6902,69 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3998,10 +6976,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSupportingDocumentType", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSupportingDocumentType" } }, "/v1/TrustProducts": { @@ -4010,14 +6985,13 @@ "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": { "mapping": { @@ -4038,7 +7012,8 @@ "resource_url": "/v1/TrustProducts/{trust_product_sid}/ChannelEndpointAssignments" } }, - "className": "trust_products" + "className": "trust_products", + "pathType": "list" }, "post": { "description": "Create a new Trust Product.", @@ -4051,6 +7026,65 @@ "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" + }, + "errors": null + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4063,9 +7097,6 @@ } ], "operationId": "CreateTrustProduct", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4099,6 +7130,16 @@ "Email", "PolicySid" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "Email": "email", + "PolicySid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "StatusCallback": "http://www.example.com" + } + } } } } @@ -4117,6 +7158,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/trust_product_enum_status" + }, + "examples": { + "readFull": { + "value": "draft" + } } }, { @@ -4125,6 +7171,11 @@ "description": "The string that you assigned to describe the resource.", "schema": { "type": "string" + }, + "examples": { + "readFull": { + "value": "friendly_name" + } } }, { @@ -4136,6 +7187,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^RN[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -4180,16 +7236,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4198,21 +7256,105 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListTrustProductResponse" + }, + "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": "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", + "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" + }, + "errors": null + } + ], + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4224,10 +7366,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTrustProduct", - "x-maturity": [ - "GA" - ] + "operationId": "ListTrustProduct" } }, "/v1/TrustProducts/{Sid}": { @@ -4236,14 +7375,13 @@ "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": { "mapping": { @@ -4264,7 +7402,8 @@ "resource_url": "/v1/TrustProducts/{trust_product_sid}/ChannelEndpointAssignments" } }, - "className": "trust_products" + "className": "trust_products", + "pathType": "instance" }, "get": { "description": "Fetch a specific Trust Product instance.", @@ -4291,6 +7430,69 @@ "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" + }, + "errors": [ + { + "code": 18601 + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4302,10 +7504,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTrustProduct", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTrustProduct" }, "post": { "description": "Updates a Trust Product in an account.", @@ -4331,7 +7530,87 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/trusthub.v1.trust_product" + "$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" + }, + "errors": null + } + }, + "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" + }, + "errors": null + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4344,9 +7623,6 @@ } ], "operationId": "UpdateTrustProduct", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4373,12 +7649,24 @@ "description": "The email address that will receive updates when the Trust Product resource changes status." } } + }, + "examples": { + "update": { + "value": { + "Status": "draft", + "StatusCallback": "http://www.example.com", + "FriendlyName": "friendly_name", + "Email": "email" + } + }, + "updateToInReview": { + "value": { + "Status": "pending-review" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -4410,10 +7698,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteTrustProduct", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteTrustProduct" } }, "/v1/TrustProducts/{TrustProductSid}/ChannelEndpointAssignments": { @@ -4422,14 +7707,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.", @@ -4456,6 +7741,55 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4468,9 +7802,6 @@ } ], "operationId": "CreateTrustProductChannelEndpointAssignment", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4494,6 +7825,14 @@ "ChannelEndpointType", "ChannelEndpointSid" ] + }, + "examples": { + "create": { + "value": { + "ChannelEndpointSid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ChannelEndpointType": "phone-number" + } + } } } } @@ -4526,6 +7865,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$" + }, + "examples": { + "readFull": { + "value": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -4578,16 +7922,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4596,21 +7942,95 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListTrustProductChannelEndpointAssignmentResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4622,10 +8042,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTrustProductChannelEndpointAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "ListTrustProductChannelEndpointAssignment" } }, "/v1/TrustProducts/{TrustProductSid}/ChannelEndpointAssignments/{Sid}": { @@ -4634,14 +8051,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.", @@ -4680,6 +8097,55 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4691,10 +8157,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTrustProductChannelEndpointAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTrustProductChannelEndpointAssignment" }, "delete": { "description": "Remove an Assignment Item Instance.", @@ -4737,10 +8200,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteTrustProductChannelEndpointAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteTrustProductChannelEndpointAssignment" } }, "/v1/TrustProducts/{TrustProductSid}/EntityAssignments": { @@ -4749,15 +8209,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.", @@ -4784,6 +8244,54 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4796,9 +8304,6 @@ } ], "operationId": "CreateTrustProductEntityAssignment", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4817,6 +8322,13 @@ "required": [ "ObjectSid" ] + }, + "examples": { + "create": { + "value": { + "ObjectSid": "ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -4890,16 +8402,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4908,21 +8422,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" } }, "title": "ListTrustProductEntityAssignmentResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4934,10 +8521,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTrustProductEntityAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "ListTrustProductEntityAssignment" } }, "/v1/TrustProducts/{TrustProductSid}/EntityAssignments/{Sid}": { @@ -4946,15 +8530,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.", @@ -4993,6 +8577,54 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5004,10 +8636,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTrustProductEntityAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTrustProductEntityAssignment" }, "delete": { "description": "Remove an Assignment Item Instance.", @@ -5050,10 +8679,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteTrustProductEntityAssignment", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteTrustProductEntityAssignment" } }, "/v1/TrustProducts/{TrustProductSid}/Evaluations": { @@ -5062,15 +8688,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", @@ -5097,6 +8723,271 @@ "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" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5109,9 +9000,6 @@ } ], "operationId": "CreateTrustProductEvaluation", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5130,6 +9018,18 @@ "required": [ "PolicySid" ] + }, + "examples": { + "create": { + "value": { + "PolicySid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "createCompliantSoleProprietorA2PProfile": { + "value": { + "PolicySid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -5195,16 +9095,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5213,21 +9115,246 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListTrustProductEvaluationResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5239,10 +9366,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListTrustProductEvaluation", - "x-maturity": [ - "GA" - ] + "operationId": "ListTrustProductEvaluation" } }, "/v1/TrustProducts/{TrustProductSid}/Evaluations/{Sid}": { @@ -5251,15 +9375,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.", @@ -5298,6 +9422,206 @@ "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" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5309,10 +9633,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchTrustProductEvaluation", - "x-maturity": [ - "GA" - ] + "operationId": "FetchTrustProductEvaluation" } } }, @@ -5322,6 +9643,9 @@ } ], "tags": [ + { + "name": "TrusthubV1BrandedCalling" + }, { "name": "TrusthubV1ComplianceInquiries" }, @@ -5343,6 +9667,9 @@ { "name": "TrusthubV1CustomerProfilesEvaluations" }, + { + "name": "TrusthubV1CustomerProfilesProvisionalCopy" + }, { "name": "TrusthubV1EndUser" }, @@ -5369,12 +9696,14 @@ }, { "name": "TrusthubV1TrustProductsEvaluations" + }, + { + "name": "TrusthubV1TrustProductsProvisionalCopy" } ], - "x-maturity": [ + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_verify_v2.json b/src/services/twilio-api/twilio_verify_v2.json index 8536daa8..206025be 100644 --- a/src/services/twilio-api/twilio_verify_v2.json +++ b/src/services/twilio-api/twilio_verify_v2.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "verify.v2.service.access_token": { "type": "object", @@ -1550,12 +1556,6 @@ "POST" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -1571,7 +1571,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -1581,7 +1581,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -1594,8 +1594,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", @@ -1622,6 +1622,72 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1634,9 +1700,6 @@ } ], "operationId": "CreateAccessToken", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1666,6 +1729,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" + } + } } } } @@ -1678,7 +1758,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -1691,8 +1771,8 @@ "ttl", "date_created" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "get": { "description": "Fetch an Access Token for the Entity", @@ -1731,6 +1811,58 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1742,10 +1874,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchAccessToken", - "x-maturity": [ - "GA" - ] + "operationId": "FetchAccessToken" } }, "/v2/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets": { @@ -1754,7 +1883,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -1766,8 +1895,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", @@ -1806,6 +1935,57 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1818,9 +1998,6 @@ } ], "operationId": "CreateBucket", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1841,6 +2018,14 @@ "Max", "Interval" ] + }, + "examples": { + "createBucket": { + "value": { + "Max": 5, + "Interval": 60 + } + } } } } @@ -1918,16 +2103,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1936,21 +2123,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" } }, "title": "ListBucketResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1962,10 +2225,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListBucket", - "x-maturity": [ - "GA" - ] + "operationId": "ListBucket" } }, "/v2/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets/{Sid}": { @@ -1974,7 +2234,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -1986,8 +2246,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.", @@ -2038,6 +2298,57 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2050,9 +2361,6 @@ } ], "operationId": "UpdateBucket", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2069,12 +2377,17 @@ "description": "Number of seconds that the rate limit will be enforced over." } } + }, + "examples": { + "updateBucket": { + "value": { + "Max": 5, + "Interval": 60 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -2126,6 +2439,57 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2137,10 +2501,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchBucket", - "x-maturity": [ - "GA" - ] + "operationId": "FetchBucket" }, "delete": { "description": "Delete a specific Bucket.", @@ -2195,10 +2556,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteBucket", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteBucket" } }, "/v2/Services/{ServiceSid}/Entities/{Identity}/Challenges": { @@ -2207,7 +2565,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "factor_type", @@ -2215,7 +2573,6 @@ "responded_reason", "date_created" ], - "pathType": "list", "dependentProperties": { "notifications": { "mapping": { @@ -2226,7 +2583,8 @@ "resource_url": "/v2/Services/{service_sid}/Entities/{identity}/Challenges/{challenge_sid}/Notifications" } }, - "parent": "/Services/{ServiceSid}/Entities/{Identity}" + "parent": "/Services/{ServiceSid}/Entities/{Identity}", + "pathType": "list" }, "post": { "description": "Create a new Challenge for the Factor", @@ -2268,6 +2626,149 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2280,9 +2781,6 @@ } ], "operationId": "CreateChallenge", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2322,6 +2820,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" + } + } } } } @@ -2431,16 +2965,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2449,36 +2985,164 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListChallengeResponse" + }, + "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": [] - } + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } ], - "operationId": "ListChallenge", - "x-maturity": [ - "GA" - ] + "operationId": "ListChallenge" } }, "/v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{Sid}": { @@ -2487,7 +3151,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "factor_type", @@ -2495,7 +3159,6 @@ "responded_reason", "date_created" ], - "pathType": "instance", "dependentProperties": { "notifications": { "mapping": { @@ -2506,7 +3169,8 @@ "resource_url": "/v2/Services/{service_sid}/Entities/{identity}/Challenges/{challenge_sid}/Notifications" } }, - "parent": "/Services/{ServiceSid}/Entities/{Identity}" + "parent": "/Services/{ServiceSid}/Entities/{Identity}", + "pathType": "instance" }, "get": { "description": "Fetch a specific Challenge.", @@ -2560,6 +3224,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" + } + } + } } } }, @@ -2568,6 +3271,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -2578,10 +3315,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchChallenge", - "x-maturity": [ - "GA" - ] + "operationId": "FetchChallenge" }, "post": { "description": "Verify a specific Challenge.", @@ -2635,6 +3369,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" + } + } + } } } }, @@ -2643,6 +3451,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -2654,9 +3496,6 @@ } ], "operationId": "UpdateChallenge", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2672,12 +3511,22 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -2687,14 +3536,13 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "identity", "date_created" ], - "pathType": "list", "dependentProperties": { "factors": { "mapping": { @@ -2718,7 +3566,8 @@ "resource_url": "/v2/Services/{service_sid}/Entities/{identity}/Challenges" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "Create a new Entity for the Service", @@ -2745,6 +3594,60 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2757,9 +3660,6 @@ } ], "operationId": "CreateEntity", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2775,6 +3675,13 @@ "required": [ "Identity" ] + }, + "examples": { + "create": { + "value": { + "Identity": "ff483d1ff591898a9942916050d2ca3f" + } + } } } } @@ -2840,16 +3747,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2858,21 +3767,100 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListEntityResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2884,10 +3872,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListEntity", - "x-maturity": [ - "GA" - ] + "operationId": "ListEntity" } }, "/v2/Services/{ServiceSid}/Entities/{Identity}": { @@ -2896,14 +3881,13 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "identity", "date_created" ], - "pathType": "instance", "dependentProperties": { "factors": { "mapping": { @@ -2927,7 +3911,8 @@ "resource_url": "/v2/Services/{service_sid}/Entities/{identity}/Challenges" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "delete": { "description": "Delete a specific Entity.", @@ -2973,10 +3958,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteEntity", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteEntity" }, "get": { "description": "Fetch a specific Entity.", @@ -3018,6 +4000,60 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3029,10 +4065,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchEntity", - "x-maturity": [ - "GA" - ] + "operationId": "FetchEntity" } }, "/v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid}": { @@ -3041,7 +4074,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3049,8 +4082,8 @@ "status", "factor_type" ], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Entities/{Identity}" + "parent": "/Services/{ServiceSid}/Entities/{Identity}", + "pathType": "instance" }, "delete": { "description": "Delete a specific Factor.", @@ -3108,10 +4141,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteFactor", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteFactor" }, "get": { "description": "Fetch a specific Factor.", @@ -3165,6 +4195,90 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3176,10 +4290,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.", @@ -3233,6 +4344,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" + } + } } } }, @@ -3241,6 +4400,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "OK" @@ -3252,9 +4445,6 @@ } ], "operationId": "UpdateFactor", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3300,12 +4490,25 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -3315,7 +4518,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3323,8 +4526,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.", @@ -3401,16 +4604,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3419,23 +4624,145 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListFactorResponse" - } - } + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } }, "description": "OK" } @@ -3445,10 +4772,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListFactor", - "x-maturity": [ - "GA" - ] + "operationId": "ListFactor" }, "post": { "description": "Create a new Factor for the Entity", @@ -3490,6 +4814,98 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3502,9 +4918,6 @@ } ], "operationId": "CreateNewFactor", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3575,6 +4988,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 + } + } } } } @@ -3590,7 +5029,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "form_type" @@ -3620,6 +5059,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3631,10 +5120,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchForm", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchForm" } }, "/v2/Services/{ServiceSid}/MessagingConfigurations": { @@ -3643,7 +5129,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "account_sid", @@ -3653,8 +5139,8 @@ "date_created", "date_updated" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "Create a new MessagingConfiguration for a service.", @@ -3681,6 +5167,55 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3693,9 +5228,6 @@ } ], "operationId": "CreateMessagingConfiguration", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3719,6 +5251,14 @@ "Country", "MessagingServiceSid" ] + }, + "examples": { + "create": { + "value": { + "Country": "CA", + "MessagingServiceSid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -3784,16 +5324,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3802,21 +5344,95 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListMessagingConfigurationResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3828,10 +5444,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListMessagingConfiguration", - "x-maturity": [ - "GA" - ] + "operationId": "ListMessagingConfiguration" } }, "/v2/Services/{ServiceSid}/MessagingConfigurations/{Country}": { @@ -3840,7 +5453,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "account_sid", @@ -3850,8 +5463,8 @@ "date_created", "date_updated" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "post": { "description": "Update a specific MessagingConfiguration", @@ -3887,6 +5500,55 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3899,9 +5561,6 @@ } ], "operationId": "UpdateMessagingConfiguration", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3920,6 +5579,13 @@ "required": [ "MessagingServiceSid" ] + }, + "examples": { + "update": { + "value": { + "MessagingServiceSid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -3959,6 +5625,55 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3970,10 +5685,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMessagingConfiguration", - "x-maturity": [ - "GA" - ] + "operationId": "FetchMessagingConfiguration" }, "delete": { "description": "Delete a specific MessagingConfiguration.", @@ -4013,10 +5725,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteMessagingConfiguration", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteMessagingConfiguration" } }, "/v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{ChallengeSid}/Notifications": { @@ -4025,7 +5734,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -4033,8 +5742,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", @@ -4088,6 +5797,70 @@ "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4100,9 +5873,6 @@ } ], "operationId": "CreateNotification", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4115,12 +5885,19 @@ "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": {} + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -4130,7 +5907,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -4141,7 +5918,6 @@ "date_created", "date_updated" ], - "pathType": "list", "dependentProperties": { "buckets": { "mapping": { @@ -4151,7 +5927,8 @@ "resource_url": "/v2/Services/{service_sid}/RateLimits/{rate_limit_sid}/Buckets" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "Create a new Rate Limit for a Service", @@ -4178,6 +5955,59 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4190,9 +6020,6 @@ } ], "operationId": "CreateRateLimit", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4212,6 +6039,14 @@ "required": [ "UniqueName" ] + }, + "examples": { + "createRateLimit": { + "value": { + "UniqueName": "unique.name", + "Description": "Description" + } + } } } } @@ -4277,16 +6112,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4295,21 +6132,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" } }, "title": "ListRateLimitResponse" + }, + "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" + } + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4321,10 +6222,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRateLimit", - "x-maturity": [ - "GA" - ] + "operationId": "ListRateLimit" } }, "/v2/Services/{ServiceSid}/RateLimits/{Sid}": { @@ -4333,7 +6231,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -4344,7 +6242,6 @@ "date_created", "date_updated" ], - "pathType": "instance", "dependentProperties": { "buckets": { "mapping": { @@ -4354,7 +6251,8 @@ "resource_url": "/v2/Services/{service_sid}/RateLimits/{rate_limit_sid}/Buckets" } }, - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "post": { "description": "Update a specific Rate Limit.", @@ -4393,6 +6291,59 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4405,9 +6356,6 @@ } ], "operationId": "UpdateRateLimit", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4420,12 +6368,16 @@ "description": "Description of this Rate Limit" } } + }, + "examples": { + "updateRateLimit": { + "value": { + "Description": "Description" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -4465,6 +6417,59 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4476,10 +6481,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRateLimit", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRateLimit" }, "delete": { "description": "Delete a specific Rate Limit.", @@ -4522,10 +6524,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRateLimit", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRateLimit" } }, "/v2/SafeList/Numbers": { @@ -4534,14 +6533,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.", @@ -4554,6 +6553,51 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4566,9 +6610,6 @@ } ], "operationId": "CreateSafelist", - "x-maturity": [ - "Beta" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4584,6 +6625,13 @@ "required": [ "PhoneNumber" ] + }, + "examples": { + "create": { + "value": { + "PhoneNumber": "+18001234567" + } + } } } } @@ -4596,14 +6644,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.", @@ -4633,6 +6681,51 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4644,10 +6737,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSafelist", - "x-maturity": [ - "Beta" - ] + "operationId": "FetchSafelist" }, "delete": { "description": "Remove a phone number from SafeList.", @@ -4681,10 +6771,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSafelist", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteSafelist" } }, "/v2/Services": { @@ -4693,14 +6780,13 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], - "pathType": "list", "dependentProperties": { "verifications": { "mapping": { @@ -4744,7 +6830,8 @@ }, "resource_url": "/v2/Services/{service_sid}/AccessTokens" } - } + }, + "pathType": "list" }, "post": { "description": "Create a new Verification Service.", @@ -4757,6 +6844,89 @@ "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 + }, + "whatsapp": { + "msg_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "from": "whatsapp:+1234567890" + }, + "default_template_sid": "HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verify_event_subscription_enabled": false, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4769,9 +6939,6 @@ } ], "operationId": "CreateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4875,6 +7042,29 @@ "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", + "VerifyEventSubscriptionEnabled": false + } + } } } } @@ -4928,16 +7118,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4946,21 +7138,115 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListServiceResponse" + }, + "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 + }, + "whatsapp": { + "msg_service_sid": null, + "from": null + }, + "default_template_sid": "HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verify_event_subscription_enabled": false, + "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" + } + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4972,10 +7258,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListService", - "x-maturity": [ - "GA" - ] + "operationId": "ListService" } }, "/v2/Services/{Sid}": { @@ -4984,14 +7267,13 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], - "pathType": "instance", "dependentProperties": { "verifications": { "mapping": { @@ -5035,7 +7317,8 @@ }, "resource_url": "/v2/Services/{service_sid}/AccessTokens" } - } + }, + "pathType": "instance" }, "get": { "description": "Fetch specific Verification Service Instance.", @@ -5062,6 +7345,89 @@ "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 + }, + "whatsapp": { + "msg_service_sid": null, + "from": null + }, + "default_template_sid": "HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verify_event_subscription_enabled": false, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5073,10 +7439,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchService", - "x-maturity": [ - "GA" - ] + "operationId": "FetchService" }, "delete": { "description": "Delete a specific Verification Service Instance.", @@ -5107,10 +7470,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteService", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteService" }, "post": { "description": "Update a specific Verification Service.", @@ -5137,6 +7497,89 @@ "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 + }, + "whatsapp": { + "msg_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "from": "whatsapp:+1234567890" + }, + "default_template_sid": "HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verify_event_subscription_enabled": false, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5149,9 +7592,6 @@ } ], "operationId": "UpdateService", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5252,12 +7692,33 @@ "description": "Whether to allow verifications from the service to reach the stream-events sinks if configured" } } + }, + "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", + "VerifyEventSubscriptionEnabled": false + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -5267,7 +7728,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -5277,8 +7738,8 @@ "valid", "date_created" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "Create a new Verification using a Service", @@ -5305,6 +7766,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" + } + } } } }, @@ -5318,6 +7951,40 @@ "schema": { "type": "string" } + }, + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "Created" @@ -5329,9 +7996,6 @@ } ], "operationId": "CreateVerification", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5414,6 +8078,71 @@ "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\"}", + "RiskCheck": "enable", + "Tags": "{\"tenant_id\": \"12345\"}" + } + }, + "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" + } + } } } } @@ -5426,7 +8155,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -5436,8 +8165,8 @@ "valid", "date_created" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "post": { "description": "Update a Verification status", @@ -5473,6 +8202,94 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5485,9 +8302,6 @@ } ], "operationId": "UpdateVerification", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5504,6 +8318,18 @@ "required": [ "Status" ] + }, + "examples": { + "updateVerification": { + "value": { + "Status": "canceled" + } + }, + "approveVerificationWithPn": { + "value": { + "Status": "approved" + } + } } } } @@ -5543,6 +8369,69 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5554,10 +8443,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchVerification", - "x-maturity": [ - "GA" - ] + "operationId": "FetchVerification" } }, "/v2/Attempts": { @@ -5566,7 +8452,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -5575,8 +8461,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.", @@ -5707,16 +8593,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -5725,21 +8613,114 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListVerificationAttemptResponse" + }, + "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 + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5751,10 +8732,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListVerificationAttempt", - "x-maturity": [ - "GA" - ] + "operationId": "ListVerificationAttempt" } }, "/v2/Attempts/{Sid}": { @@ -5763,7 +8741,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -5772,8 +8750,8 @@ "conversion_status", "channel" ], - "pathType": "instance", - "mountName": "verification_attempts" + "mountName": "verification_attempts", + "pathType": "instance" }, "get": { "description": "Fetch a specific verification attempt.", @@ -5799,7 +8777,75 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/verify.v2.verification_attempt" + "$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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5811,10 +8857,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchVerificationAttempt", - "x-maturity": [ - "GA" - ] + "operationId": "FetchVerificationAttempt" } }, "/v2/Attempts/Summary": { @@ -5823,7 +8866,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "total_attempts", @@ -5831,8 +8874,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.", @@ -5849,6 +8892,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^VA[0-9a-fA-F]{32}$" + }, + "examples": { + "getAttemptsSummary": { + "value": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -5858,6 +8906,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "getAttemptsSummary": { + "value": "2022-03-02T21:02:33Z" + } } }, { @@ -5867,6 +8920,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "getAttemptsSummary": { + "value": "2022-03-02T21:02:33Z" + } } }, { @@ -5876,6 +8934,11 @@ "schema": { "type": "string", "format": "iso-country-code" + }, + "examples": { + "getAttemptsSummary": { + "value": "CO" + } } }, { @@ -5885,6 +8948,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/verification_attempts_summary_enum_channels" + }, + "examples": { + "getAttemptsSummary": { + "value": "sms" + } } }, { @@ -5893,6 +8961,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" + } } } ], @@ -5902,6 +8975,53 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5913,10 +9033,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchVerificationAttemptsSummary", - "x-maturity": [ - "GA" - ] + "operationId": "FetchVerificationAttemptsSummary" } }, "/v2/Services/{ServiceSid}/VerificationCheck": { @@ -5925,7 +9042,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -5935,9 +9052,9 @@ "valid", "date_created" ], - "pathType": "list", "parent": "/Services/{Sid}", - "mountName": "verification_checks" + "mountName": "verification_checks", + "pathType": "list" }, "post": { "description": "challenge a specific Verification Check.", @@ -5964,6 +9081,97 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -5976,9 +9184,6 @@ } ], "operationId": "CreateVerificationCheck", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6010,12 +9215,32 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -6025,7 +9250,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -6089,16 +9314,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -6107,21 +9334,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" } }, "title": "ListVerificationTemplateResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6133,10 +9448,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListVerificationTemplate", - "x-maturity": [ - "GA" - ] + "operationId": "ListVerificationTemplate" } }, "/v2/Services/{ServiceSid}/Webhooks": { @@ -6145,7 +9457,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -6157,8 +9469,8 @@ "status", "date_created" ], - "pathType": "list", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "Create a new Webhook for the Service", @@ -6185,6 +9497,63 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6197,9 +9566,6 @@ } ], "operationId": "CreateWebhook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6238,6 +9604,19 @@ "EventTypes", "WebhookUrl" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "name", + "EventTypes": [ + "factor.deleted", + "factor.verified" + ], + "WebhookUrl": "https://owlbank.twilio.com", + "Version": "v2" + } + } } } } @@ -6303,16 +9682,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -6321,21 +9702,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" } }, "title": "ListWebhookResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6347,10 +9810,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "ListWebhook" } }, "/v2/Services/{ServiceSid}/Webhooks/{Sid}": { @@ -6359,7 +9819,7 @@ "url": "https://verify.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -6371,8 +9831,8 @@ "status", "date_created" ], - "pathType": "instance", - "parent": "/Services/{Sid}" + "parent": "/Services/{Sid}", + "pathType": "instance" }, "post": { "description": "", @@ -6411,6 +9871,63 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6423,9 +9940,6 @@ } ], "operationId": "UpdateWebhook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6459,12 +9973,23 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -6508,10 +10033,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteWebhook" }, "get": { "description": "Fetch a specific Webhook.", @@ -6550,6 +10072,63 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -6561,10 +10140,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchWebhook", - "x-maturity": [ - "GA" - ] + "operationId": "FetchWebhook" } } }, @@ -6629,14 +10205,9 @@ "name": "VerifyV2Webhook" } ], - "x-maturity": [ - { - "name": "GA", - "description": "This product is Generally Available." - }, + "security": [ { - "name": "Beta", - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_video_v1.json b/src/services/twilio-api/twilio_video_v1.json index 187cadab..7ebdf31f 100644 --- a/src/services/twilio-api/twilio_video_v1.json +++ b/src/services/twilio-api/twilio_video_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "video.v1.composition": { "type": "object", @@ -1323,12 +1329,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -1344,7 +1344,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -1362,7 +1362,6 @@ "resolution", "format" ], - "pathType": "instance", "dependentProperties": { "media": { "mapping": { @@ -1370,7 +1369,8 @@ }, "resource_url": "/v1/Compositions/{composition_sid}/Media" } - } + }, + "pathType": "instance" }, "get": { "description": "Returns a single Composition resource identified by a Composition SID.", @@ -1397,6 +1397,110 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1408,10 +1512,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchComposition", - "x-maturity": [ - "GA" - ] + "operationId": "FetchComposition" }, "delete": { "description": "Delete a Recording Composition resource identified by a Composition SID.", @@ -1442,10 +1543,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteComposition", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteComposition" } }, "/v1/Compositions": { @@ -1462,7 +1560,6 @@ "resolution", "format" ], - "pathType": "list", "dependentProperties": { "media": { "mapping": { @@ -1470,7 +1567,8 @@ }, "resource_url": "/v1/Compositions/{composition_sid}/Media" } - } + }, + "pathType": "list" }, "get": { "description": "List of all Recording compositions.", @@ -1485,6 +1583,17 @@ "schema": { "type": "string", "$ref": "#/components/schemas/composition_enum_status" + }, + "examples": { + "readEnqueued": { + "value": "enqueued" + }, + "readEmpty": { + "value": "completed" + }, + "readResults": { + "value": "completed" + } } }, { @@ -1494,6 +1603,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readResults": { + "value": "2017-01-01T00:00:01Z" + } } }, { @@ -1503,6 +1617,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readResults": { + "value": "2017-12-31T23:59:59Z" + } } }, { @@ -1514,6 +1633,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^RM[0-9a-fA-F]{32}$" + }, + "examples": { + "readResults": { + "value": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } }, { @@ -1558,16 +1682,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1576,21 +1702,160 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListCompositionResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1602,10 +1867,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListComposition", - "x-maturity": [ - "GA" - ] + "operationId": "ListComposition" }, "post": { "description": "", @@ -1618,6 +1880,98 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1630,9 +1984,6 @@ } ], "operationId": "CreateComposition", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1695,6 +2046,24 @@ "required": [ "RoomSid" ] + }, + "examples": { + "create": { + "value": { + "RoomSid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "AudioSources": [ + "RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "user*" + ], + "AudioSourcesExcluded": [ + "RTbaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "VideoLayout": "{}", + "Trim": true, + "Format": "mp4", + "Resolution": "1920x1080" + } + } } } } @@ -1741,6 +2110,100 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1752,10 +2215,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCompositionHook", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCompositionHook" }, "delete": { "description": "Delete a Recording CompositionHook resource identified by a `CompositionHook SID`.", @@ -1786,10 +2246,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCompositionHook", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCompositionHook" }, "post": { "description": "", @@ -1816,6 +2273,113 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1828,9 +2392,6 @@ } ], "operationId": "UpdateCompositionHook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1894,6 +2455,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" + } + } } } } @@ -1927,6 +2523,14 @@ "description": "Read only CompositionHook resources with an `enabled` value that matches this parameter.", "schema": { "type": "boolean" + }, + "examples": { + "readEmpty": { + "value": true + }, + "readResults": { + "value": true + } } }, { @@ -1936,6 +2540,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readResults": { + "value": "2017-01-01T00:00:01Z" + } } }, { @@ -1945,6 +2554,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readResults": { + "value": "2017-12-31T23:59:59Z" + } } }, { @@ -1953,6 +2567,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*" + } } }, { @@ -1997,16 +2616,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2015,21 +2636,138 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListCompositionHookResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2041,10 +2779,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCompositionHook", - "x-maturity": [ - "GA" - ] + "operationId": "ListCompositionHook" }, "post": { "description": "", @@ -2057,6 +2792,89 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2069,9 +2887,6 @@ } ], "operationId": "CreateCompositionHook", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2135,6 +2950,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" + } + } } } } @@ -2154,9 +2990,9 @@ "aws_storage_enabled", "encryption_enabled" ], - "pathType": "instance", "mountName": "composition_settings", - "className": "composition_settings" + "className": "composition_settings", + "pathType": "instance" }, "get": { "description": "", @@ -2169,6 +3005,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2180,10 +3066,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCompositionSettings", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCompositionSettings" }, "post": { "description": "", @@ -2196,7 +3079,57 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } } }, "description": "Created" @@ -2208,9 +3141,6 @@ } ], "operationId": "CreateCompositionSettings", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2253,6 +3183,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 + } + } } } } @@ -2275,7 +3217,6 @@ "duration", "codec" ], - "pathType": "instance", "dependentProperties": { "media": { "mapping": { @@ -2283,7 +3224,8 @@ }, "resource_url": "/v1/Recordings/{recording_sid}/Media" } - } + }, + "pathType": "instance" }, "get": { "description": "Returns a single Recording resource identified by a Recording SID.", @@ -2310,6 +3252,73 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2321,10 +3330,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRecording", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRecording" }, "delete": { "description": "Delete a Recording resource identified by a Recording SID.", @@ -2355,10 +3361,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRecording", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRecording" } }, "/v1/Recordings": { @@ -2377,7 +3380,6 @@ "duration", "codec" ], - "pathType": "list", "dependentProperties": { "media": { "mapping": { @@ -2385,7 +3387,8 @@ }, "resource_url": "/v1/Recordings/{recording_sid}/Media" } - } + }, + "pathType": "list" }, "get": { "description": "List of all Track recordings.", @@ -2400,6 +3403,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/recording_enum_status" + }, + "examples": { + "readEmpty": { + "value": "completed" + }, + "readResults": { + "value": "completed" + } } }, { @@ -2411,6 +3422,14 @@ "minLength": 34, "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$" + }, + "examples": { + "readEmpty": { + "value": "source_sid" + }, + "readResults": { + "value": "source_sid" + } } }, { @@ -2425,6 +3444,19 @@ "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$" } + }, + "examples": { + "readEmpty": { + "value": [ + "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ] + }, + "readResults": { + "value": [ + "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ] + } } }, { @@ -2434,6 +3466,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readResults": { + "value": "2017-01-01T00:00:01Z" + } } }, { @@ -2443,6 +3480,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readResults": { + "value": "2017-12-31T23:59:59Z" + } } }, { @@ -2452,6 +3494,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/recording_enum_type" + }, + "examples": { + "readEmpty": { + "value": "audio" + }, + "readResults": { + "value": "audio" + } } }, { @@ -2496,16 +3546,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2514,21 +3566,114 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListRecordingResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2540,10 +3685,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRecording", - "x-maturity": [ - "GA" - ] + "operationId": "ListRecording" } }, "/v1/RecordingSettings/Default": { @@ -2559,9 +3701,9 @@ "aws_storage_enabled", "encryption_enabled" ], - "pathType": "instance", "mountName": "recording_settings", - "className": "recording_settings" + "className": "recording_settings", + "pathType": "instance" }, "get": { "description": "", @@ -2574,6 +3716,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2585,10 +3777,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRecordingSettings", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRecordingSettings" }, "post": { "description": "", @@ -2601,6 +3790,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2613,9 +3852,6 @@ } ], "operationId": "CreateRecordingSettings", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2658,6 +3894,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 + } + } } } } @@ -2677,7 +3925,6 @@ "unique_name", "status" ], - "pathType": "instance", "dependentProperties": { "recordings": { "mapping": { @@ -2697,7 +3944,8 @@ }, "resource_url": "/v1/Rooms/{room_sid}/RecordingRules" } - } + }, + "pathType": "instance" }, "get": { "description": "", @@ -2721,6 +3969,78 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2732,10 +4052,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRoom", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRoom" }, "post": { "description": "", @@ -2759,6 +4076,78 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2771,9 +4160,6 @@ } ], "operationId": "UpdateRoom", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2790,6 +4176,13 @@ "required": [ "Status" ] + }, + "examples": { + "update": { + "value": { + "Status": "completed" + } + } } } } @@ -2809,7 +4202,6 @@ "unique_name", "status" ], - "pathType": "list", "dependentProperties": { "recordings": { "mapping": { @@ -2829,7 +4221,8 @@ }, "resource_url": "/v1/Rooms/{room_sid}/RecordingRules" } - } + }, + "pathType": "list" }, "post": { "description": "", @@ -2842,6 +4235,278 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2854,9 +4519,6 @@ } ], "operationId": "CreateRoom", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2935,12 +4597,56 @@ "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 + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -2956,6 +4662,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/room_enum_room_status" + }, + "examples": { + "readWithStatus": { + "value": "completed" + } } }, { @@ -3026,16 +4737,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3044,21 +4757,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" } }, "title": "ListRoomResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3070,10 +4880,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRoom", - "x-maturity": [ - "GA" - ] + "operationId": "ListRoom" } }, "/v1/Rooms/{RoomSid}/Participants/{Sid}": { @@ -3089,7 +4896,6 @@ "identity", "status" ], - "pathType": "instance", "dependentProperties": { "published_tracks": { "mapping": { @@ -3120,7 +4926,8 @@ "resource_url": "/v1/Rooms/{room_sid}/Participants/{sid}/Anonymize" } }, - "parent": "/Rooms/{Sid}" + "parent": "/Rooms/{Sid}", + "pathType": "instance" }, "get": { "description": "", @@ -3153,6 +4960,65 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3164,10 +5030,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRoomParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRoomParticipant" }, "post": { "description": "", @@ -3200,6 +5063,65 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3212,9 +5134,6 @@ } ], "operationId": "UpdateRoomParticipant", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3228,12 +5147,16 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -3250,7 +5173,6 @@ "identity", "status" ], - "pathType": "list", "dependentProperties": { "published_tracks": { "mapping": { @@ -3281,7 +5203,8 @@ "resource_url": "/v1/Rooms/{room_sid}/Participants/{sid}/Anonymize" } }, - "parent": "/Rooms/{Sid}" + "parent": "/Rooms/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -3305,6 +5228,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/room_participant_enum_status" + }, + "examples": { + "readFilters": { + "value": "disconnected" + } } }, { @@ -3313,6 +5241,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" + } } }, { @@ -3322,6 +5255,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFilters": { + "value": "2017-01-01T00:00:01Z" + } } }, { @@ -3331,6 +5269,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readFilters": { + "value": "2017-12-31T23:59:59Z" + } } }, { @@ -3375,16 +5318,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3393,21 +5338,105 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListRoomParticipantResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3419,10 +5448,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRoomParticipant", - "x-maturity": [ - "GA" - ] + "operationId": "ListRoomParticipant" } }, "/v1/Rooms/{RoomSid}/Participants/{Sid}/Anonymize": { @@ -3431,15 +5457,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": "", @@ -3472,6 +5498,59 @@ "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 + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3483,10 +5562,7 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateRoomParticipantAnonymize", - "x-maturity": [ - "GA" - ] + "operationId": "UpdateRoomParticipantAnonymize" } }, "/v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/PublishedTracks/{Sid}": { @@ -3495,7 +5571,7 @@ "url": "https://video.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3503,8 +5579,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.", @@ -3545,7 +5621,58 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/video.v1.room.room_participant.room_participant_published_track" + "$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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3557,10 +5684,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRoomParticipantPublishedTrack", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRoomParticipantPublishedTrack" } }, "/v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/PublishedTracks": { @@ -3569,7 +5693,7 @@ "url": "https://video.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3577,8 +5701,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.", @@ -3646,16 +5770,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -3664,21 +5790,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" } }, "title": "ListRoomParticipantPublishedTrackResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3690,10 +5866,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRoomParticipantPublishedTrack", - "x-maturity": [ - "GA" - ] + "operationId": "ListRoomParticipantPublishedTrack" } }, "/v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/SubscribeRules": { @@ -3702,16 +5875,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.", @@ -3744,6 +5917,62 @@ "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 + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3755,10 +5984,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRoomParticipantSubscribeRule", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRoomParticipantSubscribeRule" }, "post": { "description": "Update the Subscribe Rules for the Participant", @@ -3791,6 +6017,62 @@ "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 + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3803,9 +6085,6 @@ } ], "operationId": "UpdateRoomParticipantSubscribeRule", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3817,12 +6096,16 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -3832,7 +6115,7 @@ "url": "https://video.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3840,8 +6123,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.", @@ -3886,6 +6169,58 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -3897,10 +6232,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRoomParticipantSubscribedTrack", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRoomParticipantSubscribedTrack" } }, "/v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/SubscribedTracks": { @@ -3909,7 +6241,7 @@ "url": "https://video.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", @@ -3917,8 +6249,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.", @@ -3986,16 +6318,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -4004,21 +6338,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" } }, "title": "ListRoomParticipantSubscribedTrackResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4030,10 +6414,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRoomParticipantSubscribedTrack", - "x-maturity": [ - "GA" - ] + "operationId": "ListRoomParticipantSubscribedTrack" } }, "/v1/Rooms/{RoomSid}/Recordings/{Sid}": { @@ -4052,7 +6433,6 @@ "duration", "codec" ], - "pathType": "instance", "dependentProperties": { "media": { "mapping": { @@ -4063,7 +6443,8 @@ } }, "parent": "/Rooms/{Sid}", - "className": "room_recording" + "className": "room_recording", + "pathType": "instance" }, "get": { "description": "", @@ -4102,6 +6483,72 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4113,10 +6560,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRoomRecording", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRoomRecording" }, "delete": { "description": "", @@ -4159,10 +6603,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRoomRecording", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRoomRecording" } }, "/v1/Rooms/{RoomSid}/Recordings": { @@ -4181,7 +6622,6 @@ "duration", "codec" ], - "pathType": "list", "dependentProperties": { "media": { "mapping": { @@ -4192,7 +6632,8 @@ } }, "parent": "/Rooms/{Sid}", - "className": "room_recording" + "className": "room_recording", + "pathType": "list" }, "get": { "description": "", @@ -4219,6 +6660,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/room_recording_enum_status" + }, + "examples": { + "readResults": { + "value": "completed" + } } }, { @@ -4230,6 +6676,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$" + }, + "examples": { + "readResults": { + "value": "source_sid" + } } }, { @@ -4239,6 +6690,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readResults": { + "value": "2017-01-01T00:00:01Z" + } } }, { @@ -4248,6 +6704,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "readResults": { + "value": "2017-12-31T23:59:59Z" + } } }, { @@ -4292,16 +6753,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "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,21 +6773,113 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListRoomRecordingResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4336,10 +6891,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRoomRecording", - "x-maturity": [ - "GA" - ] + "operationId": "ListRoomRecording" } }, "/v1/Rooms/{RoomSid}/RecordingRules": { @@ -4348,15 +6900,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.", @@ -4380,6 +6932,57 @@ "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 + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4391,10 +6994,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRoomRecordingRule", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRoomRecordingRule" }, "post": { "description": "Update the Recording Rules for the Room", @@ -4418,6 +7018,57 @@ "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 + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -4430,9 +7081,6 @@ } ], "operationId": "UpdateRoomRecordingRule", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4444,12 +7092,16 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } } @@ -4472,6 +7124,9 @@ { "name": "VideoV1CompositionSettings" }, + { + "name": "VideoV1Media" + }, { "name": "VideoV1Participant" }, @@ -4500,10 +7155,9 @@ "name": "VideoV1SubscribedTrack" } ], - "x-maturity": [ + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_voice_v1.json b/src/services/twilio-api/twilio_voice_v1.json index 272fdfcd..6aeedd7a 100644 --- a/src/services/twilio-api/twilio_voice_v1.json +++ b/src/services/twilio-api/twilio_voice_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "voice.v1.archived_call": { "type": "object", @@ -503,6 +509,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": { @@ -550,12 +579,6 @@ } } } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -571,7 +594,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -581,11 +604,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.", @@ -626,10 +649,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteArchivedCall", - "x-maturity": [ - "Beta" - ] + "operationId": "DeleteArchivedCall" } }, "/v1/ByocTrunks": { @@ -658,6 +678,63 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -670,9 +747,6 @@ } ], "operationId": "CreateByocTrunk", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -745,12 +819,25 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -801,16 +888,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -819,21 +908,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" } }, "title": "ListByocTrunkResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -845,10 +1016,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListByocTrunk", - "x-maturity": [ - "GA" - ] + "operationId": "ListByocTrunk" } }, "/v1/ByocTrunks/{Sid}": { @@ -891,6 +1059,63 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -902,10 +1127,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchByocTrunk", - "x-maturity": [ - "GA" - ] + "operationId": "FetchByocTrunk" }, "post": { "description": "", @@ -932,6 +1154,63 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -944,9 +1223,6 @@ } ], "operationId": "UpdateByocTrunk", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1019,12 +1295,25 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -1056,10 +1345,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteByocTrunk", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteByocTrunk" } }, "/v1/ConnectionPolicies": { @@ -1074,7 +1360,6 @@ "sid", "friendly_name" ], - "pathType": "list", "dependentProperties": { "targets": { "mapping": { @@ -1082,7 +1367,8 @@ }, "resource_url": "/v1/ConnectionPolicies/{connection_policy_sid}/Targets" } - } + }, + "pathType": "list" }, "post": { "description": "", @@ -1095,6 +1381,57 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1107,9 +1444,6 @@ } ], "operationId": "CreateConnectionPolicy", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1122,12 +1456,16 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "get": { @@ -1178,16 +1516,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1196,21 +1536,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" } }, "title": "ListConnectionPolicyResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1222,10 +1638,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListConnectionPolicy", - "x-maturity": [ - "GA" - ] + "operationId": "ListConnectionPolicy" } }, "/v1/ConnectionPolicies/{Sid}": { @@ -1240,7 +1653,6 @@ "sid", "friendly_name" ], - "pathType": "instance", "dependentProperties": { "targets": { "mapping": { @@ -1248,7 +1660,8 @@ }, "resource_url": "/v1/ConnectionPolicies/{connection_policy_sid}/Targets" } - } + }, + "pathType": "instance" }, "get": { "description": "", @@ -1275,6 +1688,57 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1286,10 +1750,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConnectionPolicy", - "x-maturity": [ - "GA" - ] + "operationId": "FetchConnectionPolicy" }, "post": { "description": "", @@ -1316,6 +1777,57 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1328,9 +1840,6 @@ } ], "operationId": "UpdateConnectionPolicy", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1343,12 +1852,16 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -1380,10 +1893,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteConnectionPolicy", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteConnectionPolicy" } }, "/v1/ConnectionPolicies/{ConnectionPolicySid}/Targets": { @@ -1400,9 +1910,9 @@ "target", "enabled" ], - "pathType": "list", "parent": "/ConnectionPolicies/{Sid}", - "className": "connection_policy_target" + "className": "connection_policy_target", + "pathType": "list" }, "post": { "description": "", @@ -1429,6 +1939,59 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1441,9 +2004,6 @@ } ], "operationId": "CreateConnectionPolicyTarget", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1476,6 +2036,17 @@ "required": [ "Target" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "Target": "sip:sip-box.com:1234", + "Priority": 1, + "Weight": 20, + "Enabled": true + } + } } } } @@ -1541,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" @@ -1559,21 +2132,99 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListConnectionPolicyTargetResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1585,10 +2236,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListConnectionPolicyTarget", - "x-maturity": [ - "GA" - ] + "operationId": "ListConnectionPolicyTarget" } }, "/v1/ConnectionPolicies/{ConnectionPolicySid}/Targets/{Sid}": { @@ -1605,9 +2253,9 @@ "target", "enabled" ], - "pathType": "instance", "parent": "/ConnectionPolicies/{Sid}", - "className": "connection_policy_target" + "className": "connection_policy_target", + "pathType": "instance" }, "get": { "description": "", @@ -1646,22 +2294,72 @@ "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" - ] - }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchConnectionPolicyTarget" + }, "post": { "description": "", "tags": [ @@ -1699,6 +2397,59 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1711,9 +2462,6 @@ } ], "operationId": "UpdateConnectionPolicyTarget", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1743,12 +2491,20 @@ "description": "Whether the Target is enabled." } } + }, + "examples": { + "update": { + "value": { + "FriendlyName": "updated_name", + "Target": "sip:sip-updated.com:4321", + "Priority": 2, + "Weight": 10, + "Enabled": false + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -1792,10 +2548,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteConnectionPolicyTarget", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteConnectionPolicyTarget" } }, "/v1/DialingPermissions": { @@ -1804,11 +2557,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}": { @@ -1817,14 +2570,13 @@ "url": "https://voice.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "iso_code", "name", "continent" ], - "pathType": "instance", "dependentProperties": { "highrisk_special_prefixes": { "mapping": { @@ -1833,7 +2585,8 @@ "resource_url": "/v1/DialingPermissions/Countries/{iso_code}/HighRiskSpecialPrefixes" } }, - "parent": "/DialingPermissions" + "parent": "/DialingPermissions", + "pathType": "instance" }, "get": { "description": "Retrieve voice dialing country permissions identified by the given ISO country code", @@ -1858,6 +2611,61 @@ "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1869,10 +2677,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDialingPermissionsCountry", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchDialingPermissionsCountry" } }, "/v1/DialingPermissions/Countries": { @@ -1881,14 +2686,13 @@ "url": "https://voice.twilio.com" } ], - "description": "TODO: Resource-level docs", + "description": "", "x-twilio": { "defaultOutputProperties": [ "iso_code", "name", "continent" ], - "pathType": "list", "dependentProperties": { "highrisk_special_prefixes": { "mapping": { @@ -1897,7 +2701,8 @@ "resource_url": "/v1/DialingPermissions/Countries/{iso_code}/HighRiskSpecialPrefixes" } }, - "parent": "/DialingPermissions" + "parent": "/DialingPermissions", + "pathType": "list" }, "get": { "description": "Retrieve all voice dialing country permissions for this account", @@ -1912,6 +2717,11 @@ "schema": { "type": "string", "format": "iso-country-code" + }, + "examples": { + "readUs": { + "value": "US" + } } }, { @@ -1996,16 +2806,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2014,21 +2826,87 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListDialingPermissionsCountryResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2040,10 +2918,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListDialingPermissionsCountry", - "x-maturity": [ - "Preview" - ] + "operationId": "ListDialingPermissionsCountry" } }, "/v1/DialingPermissions/BulkCountryUpdates": { @@ -2052,14 +2927,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)", @@ -2072,6 +2947,50 @@ "application/json": { "schema": { "$ref": "#/components/schemas/voice.v1.dialing_permissions.dialing_permissions_country_bulk_update" + }, + "examples": { + "create": { + "value": { + "update_count": 1, + "update_request": "accepted" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2084,9 +3003,6 @@ } ], "operationId": "CreateDialingPermissionsCountryBulkUpdate", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2102,6 +3018,13 @@ "required": [ "UpdateRequest" ] + }, + "examples": { + "create": { + "value": { + "UpdateRequest": "[ { \"iso_code\": \"GB\", \"low_risk_numbers\": \"Enabled\", \"high_risk_special_numbers\":\"Enabled\", \"high_risk_irsf_numbers\": \"Enabled\" } ]" + } + } } } } @@ -2114,14 +3037,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)", @@ -2181,16 +3104,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2199,21 +3124,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" } }, "title": "ListDialingPermissionsHrsPrefixesResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2225,10 +3207,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListDialingPermissionsHrsPrefixes", - "x-maturity": [ - "Preview" - ] + "operationId": "ListDialingPermissionsHrsPrefixes" } }, "/v1/Settings": { @@ -2237,14 +3216,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", @@ -2257,6 +3236,50 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2268,10 +3291,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDialingPermissionsSettings", - "x-maturity": [ - "Preview" - ] + "operationId": "FetchDialingPermissionsSettings" }, "post": { "description": "Update voice dialing permissions inheritance for the sub-account", @@ -2284,6 +3304,50 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2296,9 +3360,6 @@ } ], "operationId": "UpdateDialingPermissionsSettings", - "x-maturity": [ - "Preview" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2311,12 +3372,16 @@ "description": "`true` for the sub-account to inherit voice dialing permissions from the Master Project; otherwise `false`." } } + }, + "examples": { + "update": { + "value": { + "DialingPermissionsInheritance": true + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -2347,6 +3412,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2359,9 +3474,6 @@ } ], "operationId": "CreateIpRecord", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2385,6 +3497,15 @@ "required": [ "IpAddress" ] + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "IpAddress": "10.2.3.4", + "CidrPrefixLength": 30 + } + } } } } @@ -2438,16 +3559,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2456,21 +3579,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" } }, "title": "ListIpRecordResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2482,10 +3680,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListIpRecord", - "x-maturity": [ - "GA" - ] + "operationId": "ListIpRecord" } }, "/v1/IpRecords/{Sid}": { @@ -2529,6 +3724,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2540,10 +3785,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchIpRecord", - "x-maturity": [ - "GA" - ] + "operationId": "FetchIpRecord" }, "post": { "description": "", @@ -2570,6 +3812,56 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2582,9 +3874,6 @@ } ], "operationId": "UpdateIpRecord", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2597,12 +3886,16 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -2634,10 +3927,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteIpRecord", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteIpRecord" } }, "/v1/SourceIpMappings": { @@ -2666,6 +3956,54 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2678,9 +4016,6 @@ } ], "operationId": "CreateSourceIpMapping", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2707,6 +4042,14 @@ "IpRecordSid", "SipDomainSid" ] + }, + "examples": { + "create": { + "value": { + "IpRecordSid": "ILaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "SipDomainSid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } } } } @@ -2760,16 +4103,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2778,21 +4123,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" } }, "title": "ListSourceIpMappingResponse" + }, + "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": [] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2804,10 +4222,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSourceIpMapping", - "x-maturity": [ - "GA" - ] + "operationId": "ListSourceIpMapping" } }, "/v1/SourceIpMappings/{Sid}": { @@ -2850,6 +4265,54 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2861,10 +4324,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSourceIpMapping", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSourceIpMapping" }, "post": { "description": "", @@ -2891,6 +4351,54 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2903,9 +4411,6 @@ } ], "operationId": "UpdateSourceIpMapping", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2924,6 +4429,13 @@ "required": [ "SipDomainSid" ] + }, + "examples": { + "update": { + "value": { + "SipDomainSid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + } + } } } } @@ -2958,10 +4470,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSourceIpMapping", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSourceIpMapping" } } }, @@ -2996,24 +4505,24 @@ "name": "VoiceV1IpRecord" }, { - "name": "VoiceV1Settings" + "name": "VoiceV1Media" }, { - "name": "VoiceV1SourceIpMapping" - } - ], - "x-maturity": [ + "name": "VoiceV1MediaUrl" + }, { - "name": "GA", - "description": "This product is Generally Available." + "name": "VoiceV1Recording" }, { - "name": "Beta", - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." + "name": "VoiceV1Settings" }, { - "name": "Preview", - "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact https://www.twilio.com/help/contact." + "name": "VoiceV1SourceIpMapping" + } + ], + "security": [ + { + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/src/services/twilio-api/twilio_wireless_v1.json b/src/services/twilio-api/twilio_wireless_v1.json index 1870d4fa..6ae70aec 100644 --- a/src/services/twilio-api/twilio_wireless_v1.json +++ b/src/services/twilio-api/twilio_wireless_v1.json @@ -1,5 +1,11 @@ { "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, "schemas": { "wireless.v1.account_usage_record": { "type": "object", @@ -591,12 +597,6 @@ "all" ] } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } } }, "info": { @@ -612,7 +612,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.56.1" + "version": "1.0.0" }, "openapi": "3.0.1", "paths": { @@ -642,6 +642,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2015-07-30T20:00:00Z" + } } }, { @@ -651,6 +656,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2015-07-30T20:00:00Z" + } } }, { @@ -704,16 +714,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -722,21 +734,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" } }, "title": "ListAccountUsageRecordResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -748,10 +871,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListAccountUsageRecord", - "x-maturity": [ - "GA" - ] + "operationId": "ListAccountUsageRecord" } }, "/v1/Commands/{Sid}": { @@ -797,6 +917,76 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -808,10 +998,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchCommand", - "x-maturity": [ - "GA" - ] + "operationId": "FetchCommand" }, "delete": { "description": "Delete a Command instance from your account.", @@ -842,10 +1029,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteCommand", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteCommand" } }, "/v1/Commands": { @@ -878,6 +1062,17 @@ "description": "The `sid` or `unique_name` of the [Sim resources](https://www.twilio.com/docs/iot/wireless/api/sim-resource) to read.", "schema": { "type": "string" + }, + "examples": { + "readEmpty": { + "value": "sim" + }, + "readFull": { + "value": "sim" + }, + "readIp": { + "value": "sim" + } } }, { @@ -887,6 +1082,17 @@ "schema": { "type": "string", "$ref": "#/components/schemas/command_enum_status" + }, + "examples": { + "readEmpty": { + "value": "queued" + }, + "readFull": { + "value": "queued" + }, + "readIp": { + "value": "queued" + } } }, { @@ -896,6 +1102,17 @@ "schema": { "type": "string", "$ref": "#/components/schemas/command_enum_direction" + }, + "examples": { + "readEmpty": { + "value": "from_sim" + }, + "readFull": { + "value": "from_sim" + }, + "readIp": { + "value": "to_sim" + } } }, { @@ -905,6 +1122,11 @@ "schema": { "type": "string", "$ref": "#/components/schemas/command_enum_transport" + }, + "examples": { + "readIp": { + "value": "ip" + } } }, { @@ -949,16 +1171,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "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,21 +1191,129 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListCommandResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -993,10 +1325,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListCommand", - "x-maturity": [ - "GA" - ] + "operationId": "ListCommand" }, "post": { "description": "Send a Command to a Sim.", @@ -1009,6 +1338,76 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1021,9 +1420,6 @@ } ], "operationId": "CreateCommand", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1070,6 +1466,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" + } + } } } } @@ -1091,8 +1510,8 @@ "start", "end" ], - "pathType": "list", - "parent": "/Sims/{Sid}" + "parent": "/Sims/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -1151,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" @@ -1169,21 +1590,108 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListDataSessionResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1195,10 +1703,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListDataSession", - "x-maturity": [ - "GA" - ] + "operationId": "ListDataSession" } }, "/v1/RatePlans": { @@ -1265,16 +1770,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1283,21 +1790,111 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListRatePlanResponse" + }, + "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" + } + ] + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1309,10 +1906,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListRatePlan", - "x-maturity": [ - "GA" - ] + "operationId": "ListRatePlan" }, "post": { "description": "", @@ -1325,6 +1919,71 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1337,9 +1996,6 @@ } ], "operationId": "CreateRatePlan", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1395,12 +2051,31 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } } }, @@ -1442,6 +2117,71 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1453,10 +2193,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchRatePlan", - "x-maturity": [ - "GA" - ] + "operationId": "FetchRatePlan" }, "post": { "description": "", @@ -1480,6 +2217,71 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1492,9 +2294,6 @@ } ], "operationId": "UpdateRatePlan", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1511,12 +2310,19 @@ "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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -1545,10 +2351,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteRatePlan", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteRatePlan" } }, "/v1/Sims/{Sid}": { @@ -1565,7 +2368,6 @@ "friendly_name", "status" ], - "pathType": "instance", "dependentProperties": { "usage_records": { "mapping": { @@ -1579,7 +2381,8 @@ }, "resource_url": "/v1/Sims/{sim_sid}/DataSessions" } - } + }, + "pathType": "instance" }, "get": { "description": "Fetch a Sim resource on your Account.", @@ -1603,6 +2406,76 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1614,10 +2487,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSim", - "x-maturity": [ - "GA" - ] + "operationId": "FetchSim" }, "post": { "description": "Updates the given properties of a Sim resource on your Account.", @@ -1641,6 +2511,140 @@ "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" + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1653,9 +2657,6 @@ } ], "operationId": "UpdateSim", - "x-maturity": [ - "GA" - ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1774,12 +2775,44 @@ "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/iot/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" + } + } } } } - }, - "x-twilio": { - "addContentTypeIfEmptyForm": true } }, "delete": { @@ -1808,10 +2841,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSim", - "x-maturity": [ - "GA" - ] + "operationId": "DeleteSim" } }, "/v1/Sims": { @@ -1828,7 +2858,6 @@ "friendly_name", "status" ], - "pathType": "list", "dependentProperties": { "usage_records": { "mapping": { @@ -1842,7 +2871,8 @@ }, "resource_url": "/v1/Sims/{sim_sid}/DataSessions" } - } + }, + "pathType": "list" }, "get": { "description": "Retrieve a list of Sim resources on your Account.", @@ -1857,6 +2887,14 @@ "schema": { "type": "string", "$ref": "#/components/schemas/sim_enum_status" + }, + "examples": { + "readEmpty": { + "value": "new" + }, + "readFull": { + "value": "new" + } } }, { @@ -1871,6 +2909,14 @@ "handling": "standard", "deleteSla": 30 } + }, + "examples": { + "readEmpty": { + "value": "iccid" + }, + "readFull": { + "value": "iccid" + } } }, { @@ -1879,6 +2925,14 @@ "description": "The SID or unique name of a [RatePlan resource](https://www.twilio.com/docs/iot/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" + } } }, { @@ -1939,16 +2993,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -1957,21 +3013,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" } }, "title": "ListSimResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -1983,10 +3134,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSim", - "x-maturity": [ - "GA" - ] + "operationId": "ListSim" } }, "/v1/Sims/{SimSid}/UsageRecords": { @@ -2000,8 +3148,8 @@ "defaultOutputProperties": [ "period" ], - "pathType": "list", - "parent": "/Sims/{Sid}" + "parent": "/Sims/{Sid}", + "pathType": "list" }, "get": { "description": "", @@ -2025,6 +3173,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2015-07-30T20:00:00Z" + } } }, { @@ -2034,6 +3187,11 @@ "schema": { "type": "string", "format": "date-time" + }, + "examples": { + "fetch": { + "value": "2015-07-30T20:00:00Z" + } } }, { @@ -2087,16 +3245,18 @@ } }, "meta": { - "type": "object", "properties": { "first_page_url": { - "type": "string", - "format": "uri" + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" }, "next_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "page": { "type": "integer" @@ -2105,21 +3265,134 @@ "type": "integer" }, "previous_page_url": { - "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "type": "string" }, "url": { - "type": "string", - "format": "uri" - }, - "key": { + "format": "uri", "type": "string" } - } + }, + "type": "object" } }, "title": "ListUsageRecordResponse" + }, + "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" + } + } + } + } + } + }, + "headers": { + "Access-Control-Allow-Origin": { + "description": "Specify the origin(s) allowed to access the resource", + "schema": { + "type": "string" + }, + "example": "*" + }, + "Access-Control-Allow-Methods": { + "description": "Specify the HTTP methods allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "POST, OPTIONS" + }, + "Access-Control-Allow-Headers": { + "description": "Specify the headers allowed when accessing the resource", + "schema": { + "type": "string" + }, + "example": "Content-Type, Authorization" + }, + "Access-Control-Allow-Credentials": { + "description": "Indicates whether the browser should include credentials", + "schema": { + "type": "boolean" + } + }, + "Access-Control-Expose-Headers": { + "description": "Headers exposed to the client", + "schema": { + "type": "string", + "example": "X-Custom-Header1, X-Custom-Header2" } } }, @@ -2131,10 +3404,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListUsageRecord", - "x-maturity": [ - "GA" - ] + "operationId": "ListUsageRecord" } } }, @@ -2160,10 +3430,9 @@ "name": "WirelessV1UsageRecord" } ], - "x-maturity": [ + "security": [ { - "name": "GA", - "description": "This product is Generally Available." + "accountSid_authToken": [] } ] } \ No newline at end of file